Interface DescribeDbClustersRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>, RdsRequest.Builder, SdkBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
DescribeDbClustersRequest
public static interface DescribeDbClustersRequest.Builder extends RdsRequest.Builder, SdkPojo, CopyableBuilder<DescribeDbClustersRequest.Builder,DescribeDbClustersRequest>

  • Method Details

    • dbClusterIdentifier

      DescribeDbClustersRequest.Builder dbClusterIdentifier(String dbClusterIdentifier)

      The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DB cluster identifier.

      Parameters:
      dbClusterIdentifier - The user-supplied DB cluster identifier or the Amazon Resource Name (ARN) of the DB cluster. If this parameter is specified, information for only the specific DB cluster is returned. This parameter isn't case-sensitive.

      Constraints:

      • If supplied, must match an existing DB cluster identifier.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeDbClustersRequest.Builder filters(Collection<Filter> filters)

      A filter that specifies one or more DB clusters to describe.

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      Parameters:
      filters - A filter that specifies one or more DB clusters to describe.

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeDbClustersRequest.Builder filters(Filter... filters)

      A filter that specifies one or more DB clusters to describe.

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      Parameters:
      filters - A filter that specifies one or more DB clusters to describe.

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • filters

      DescribeDbClustersRequest.Builder filters(Consumer<Filter.Builder>... filters)

      A filter that specifies one or more DB clusters to describe.

      Supported Filters:

      • clone-group-id - Accepts clone group identifiers. The results list only includes information about the DB clusters associated with these clone groups.

      • db-cluster-id - Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list only includes information about the DB clusters identified by these ARNs.

      • db-cluster-resource-id - Accepts DB cluster resource identifiers. The results list will only include information about the DB clusters identified by these DB cluster resource identifiers.

      • domain - Accepts Active Directory directory IDs. The results list only includes information about the DB clusters associated with these domains.

      • engine - Accepts engine names. The results list only includes information about the DB clusters for these engines.

      This is a convenience method that creates an instance of the Filter.Builder avoiding the need to create one manually via Filter.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to filters(List<Filter>).

      Parameters:
      filters - a consumer that will call methods on Filter.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • maxRecords

      DescribeDbClustersRequest.Builder maxRecords(Integer maxRecords)

      The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100

      Parameters:
      maxRecords - The maximum number of records to include in the response. If more records exist than the specified MaxRecords value, a pagination token called a marker is included in the response so you can retrieve the remaining results.

      Default: 100

      Constraints: Minimum 20, maximum 100

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • marker

      DescribeDbClustersRequest.Builder marker(String marker)

      An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.

      Parameters:
      marker - An optional pagination token provided by a previous DescribeDBClusters request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by MaxRecords.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • includeShared

      DescribeDbClustersRequest.Builder includeShared(Boolean includeShared)

      Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.

      Parameters:
      includeShared - Specifies whether the output includes information about clusters shared from other Amazon Web Services accounts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      DescribeDbClustersRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      DescribeDbClustersRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.