public static interface DescribeDbClusterSnapshotsRequest.Builder extends RdsRequest.Builder, CopyableBuilder<DescribeDbClusterSnapshotsRequest.Builder,DescribeDbClusterSnapshotsRequest>
Modifier and Type | Method and Description |
---|---|
DescribeDbClusterSnapshotsRequest.Builder |
dbClusterIdentifier(String dbClusterIdentifier)
The ID of the DB cluster to retrieve the list of DB cluster snapshots for.
|
DescribeDbClusterSnapshotsRequest.Builder |
dbClusterSnapshotIdentifier(String dbClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe.
|
DescribeDbClusterSnapshotsRequest.Builder |
filters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeDbClusterSnapshotsRequest.Builder |
filters(Consumer<Filter.Builder>... filters)
This parameter is not currently supported.
|
DescribeDbClusterSnapshotsRequest.Builder |
filters(Filter... filters)
This parameter is not currently supported.
|
DescribeDbClusterSnapshotsRequest.Builder |
includePublic(Boolean includePublic)
True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account,
and otherwise false.
|
DescribeDbClusterSnapshotsRequest.Builder |
includeShared(Boolean includeShared)
True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been
given permission to copy or restore, and otherwise false.
|
DescribeDbClusterSnapshotsRequest.Builder |
marker(String marker)
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
DescribeDbClusterSnapshotsRequest.Builder |
maxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeDbClusterSnapshotsRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
DescribeDbClusterSnapshotsRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
DescribeDbClusterSnapshotsRequest.Builder |
snapshotType(String snapshotType)
The type of DB cluster snapshots to be returned.
|
build
overrideConfiguration
copy
applyMutation, build
DescribeDbClusterSnapshotsRequest.Builder dbClusterIdentifier(String 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 is not
case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
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 is not
case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBCluster.
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.
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.
DescribeDbClusterSnapshotsRequest.Builder snapshotType(String 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 AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS 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 setting the
IncludeShared
parameter to true
. You can include public DB cluster snapshots with
these results by setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The
IncludePublic
parameter doesn't apply when SnapshotType
is set to
shared
. The IncludeShared
parameter doesn't apply when SnapshotType
is
set to public
.
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 AWS account.
manual
- Return all DB cluster snapshots that have been taken by my AWS account.
shared
- Return all manual DB cluster snapshots that have been shared to my AWS 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 setting the
IncludeShared
parameter to true
. You can include public DB cluster snapshots
with these results by setting the IncludePublic
parameter to true
.
The IncludeShared
and IncludePublic
parameters don't apply for
SnapshotType
values of manual
or automated
. The
IncludePublic
parameter doesn't apply when SnapshotType
is set to
shared
. The IncludeShared
parameter doesn't apply when
SnapshotType
is set to public
.
DescribeDbClusterSnapshotsRequest.Builder filters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.DescribeDbClusterSnapshotsRequest.Builder filters(Filter... filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.DescribeDbClusterSnapshotsRequest.Builder filters(Consumer<Filter.Builder>... filters)
This parameter is not currently supported.
This is a convenience that creates an instance of theList.Builder
avoiding the need to
create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and its
result is passed to #filters(List)
.filters
- a consumer that will call methods on List.Builder
#filters(List)
DescribeDbClusterSnapshotsRequest.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 that the
remaining results can be retrieved.
Default: 100
Constraints: Minimum 20, maximum 100.
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.
DescribeDbClusterSnapshotsRequest.Builder marker(String 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 by
MaxRecords
.
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 by MaxRecords
.DescribeDbClusterSnapshotsRequest.Builder includeShared(Boolean includeShared)
True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has been
given permission to copy or restore, and otherwise false. The default is false
.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
includeShared
- True to include shared manual DB cluster snapshots from other AWS accounts that this AWS account has
been given permission to copy or restore, and otherwise false. The default is false
.
You can give an AWS account permission to restore a manual DB cluster snapshot from another AWS account by the ModifyDBClusterSnapshotAttribute API action.
DescribeDbClusterSnapshotsRequest.Builder includePublic(Boolean includePublic)
True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS account,
and otherwise false. The default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
includePublic
- True to include manual DB cluster snapshots that are public and can be copied or restored by any AWS
account, and otherwise false. The default is false
. The default is false.
You can share a manual DB cluster snapshot as public by using the ModifyDBClusterSnapshotAttribute API action.
DescribeDbClusterSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.DescribeDbClusterSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.