Interface DescribeDbClusterSnapshotsRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,
,DescribeDbClusterSnapshotsRequest> RdsRequest.Builder
,SdkBuilder<DescribeDbClusterSnapshotsRequest.Builder,
,DescribeDbClusterSnapshotsRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
DescribeDbClusterSnapshotsRequest
-
Method Summary
Modifier and TypeMethodDescriptiondbClusterIdentifier
(String dbClusterIdentifier) The ID of the DB cluster to retrieve the list of DB cluster snapshots for.dbClusterResourceId
(String dbClusterResourceId) A specific DB cluster resource ID to describe.dbClusterSnapshotIdentifier
(String dbClusterSnapshotIdentifier) A specific DB cluster snapshot identifier to describe.filters
(Collection<Filter> filters) A filter that specifies one or more DB cluster snapshots to describe.filters
(Consumer<Filter.Builder>... filters) A filter that specifies one or more DB cluster snapshots to describe.A filter that specifies one or more DB cluster snapshots to describe.includePublic
(Boolean includePublic) Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account.includeShared
(Boolean includeShared) Specifies whether to include shared manual DB cluster snapshots from other Amazon Web Services accounts that this Amazon Web Services account has been given permission to copy or restore.An optional pagination token provided by a previousDescribeDBClusterSnapshots
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.snapshotType
(String snapshotType) The type of DB cluster snapshots to be returned.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.rds.model.RdsRequest.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 ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
- Parameters:
dbClusterIdentifier
- The ID of the DB cluster to retrieve the list of DB cluster snapshots for. This parameter can't be used in conjunction with theDBClusterSnapshotIdentifier
parameter. This parameter isn't case-sensitive.Constraints:
-
If supplied, must match the identifier of an existing DBCluster.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
dbClusterSnapshotIdentifier
DescribeDbClusterSnapshotsRequest.Builder dbClusterSnapshotIdentifier(String dbClusterSnapshotIdentifier) A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored as a lowercase string.Constraints:
-
If supplied, must match the identifier of an existing DBClusterSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
- Parameters:
dbClusterSnapshotIdentifier
- A specific DB cluster snapshot identifier to describe. This parameter can't be used in conjunction with theDBClusterIdentifier
parameter. This value is stored as a lowercase string.Constraints:
-
If supplied, must match the identifier of an existing DBClusterSnapshot.
-
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
snapshotType
The type of DB cluster snapshots to be returned. You can specify one of the following values:
-
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a
SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling theIncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.- Parameters:
snapshotType
- The type of DB cluster snapshots to be returned. You can specify one of the following values:-
automated
- Return all DB cluster snapshots that have been automatically taken by Amazon RDS for my Amazon Web Services account. -
manual
- Return all DB cluster snapshots that have been taken by my Amazon Web Services account. -
shared
- Return all manual DB cluster snapshots that have been shared to my Amazon Web Services account. -
public
- Return all DB cluster snapshots that have been marked as public.
If you don't specify a
SnapshotType
value, then both automated and manual DB cluster snapshots are returned. You can include shared DB cluster snapshots with these results by enabling theIncludeShared
parameter. You can include public DB cluster snapshots with these results by enabling theIncludePublic
parameter.The
IncludeShared
andIncludePublic
parameters don't apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn't apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn't apply whenSnapshotType
is set topublic
.-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
- Parameters:
filters
- A filter that specifies one or more DB cluster snapshots to describe.Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
- Parameters:
filters
- A filter that specifies one or more DB cluster snapshots to describe.Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
filters
A filter that specifies one or more DB cluster snapshots to describe.
Supported filters:
-
db-cluster-id
- Accepts DB cluster identifiers and DB cluster Amazon Resource Names (ARNs). -
db-cluster-snapshot-id
- Accepts DB cluster snapshot identifiers. -
snapshot-type
- Accepts types of DB cluster snapshots. -
engine
- Accepts names of database engines.
Filter.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 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 specifiedMaxRecords
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
An optional pagination token provided by a previous
DescribeDBClusterSnapshots
request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified byMaxRecords
.- Parameters:
marker
- An optional pagination token provided by a previousDescribeDBClusterSnapshots
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.
-
includePublic
Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
- Parameters:
includePublic
- Specifies whether to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon Web Services account. By default, the public snapshots are not included.You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
dbClusterResourceId
A specific DB cluster resource ID to describe.
- Parameters:
dbClusterResourceId
- A specific DB cluster resource ID to describe.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
overrideConfiguration
DescribeDbClusterSnapshotsRequest.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
DescribeDbClusterSnapshotsRequest.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.
-