Interface DescribeDbClustersRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeDbClustersRequest.Builder,
,DescribeDbClustersRequest> NeptuneRequest.Builder
,SdkBuilder<DescribeDbClustersRequest.Builder,
,DescribeDbClustersRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeDbClustersRequest
-
Method Summary
Modifier and TypeMethodDescriptiondbClusterIdentifier
(String dbClusterIdentifier) The user-supplied DB cluster identifier.filters
(Collection<Filter> filters) A filter that specifies one or more DB clusters to describe.filters
(Consumer<Filter.Builder>... filters) A filter that specifies one or more DB clusters to describe.A filter that specifies one or more DB clusters to describe.An optional pagination token provided by a previous DescribeDBClusters request.maxRecords
(Integer maxRecords) The maximum number of records to include in the response.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.services.neptune.model.NeptuneRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
dbClusterIdentifier
The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.
Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
- Parameters:
dbClusterIdentifier
- The user-supplied DB cluster identifier. If this parameter is specified, information from only the specific DB cluster is returned. This parameter isn't case-sensitive.Constraints:
-
If supplied, must match an existing DBClusterIdentifier.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB clusters to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. -
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
- Parameters:
filters
- A filter that specifies one or more DB clusters to describe.Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. -
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB clusters to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. -
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
- Parameters:
filters
- A filter that specifies one or more DB clusters to describe.Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. -
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB clusters to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). The results list will only include information about the DB clusters identified by these ARNs. -
engine
- Accepts an engine name (such asneptune
), and restricts the results list to DB clusters created by that engine.
For example, to invoke this API from the Amazon CLI and filter so that only Neptune DB clusters are returned, you could use the following command:
This is a convenience method that creates an instance of theFilter.Builder
avoiding the need to create one manually viaFilter.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tofilters(List<Filter>)
.- Parameters:
filters
- a consumer that will call methods onFilter.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
-
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 that the remaining results can be retrieved.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 specifiedMaxRecords
value, a pagination token called a marker is included in the response so that the remaining results can be retrieved.Default: 100
Constraints: Minimum 20, maximum 100.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
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 byMaxRecords
.- 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 interfaceAwsRequest.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 interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-