public static interface DescribeDbClusterSnapshotsRequest.Builder extends RdsRequest.Builder, SdkPojo, 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)
A filter that specifies one or more DB cluster snapshots to describe.
|
DescribeDbClusterSnapshotsRequest.Builder |
filters(Consumer<Filter.Builder>... filters)
A filter that specifies one or more DB cluster snapshots to describe.
|
DescribeDbClusterSnapshotsRequest.Builder |
filters(Filter... filters)
A filter that specifies one or more DB cluster snapshots to describe.
|
DescribeDbClusterSnapshotsRequest.Builder |
includePublic(Boolean includePublic)
A value that indicates whether to include manual DB cluster snapshots that are public and can be copied or
restored by any Amazon Web Services account.
|
DescribeDbClusterSnapshotsRequest.Builder |
includeShared(Boolean includeShared)
A value that indicates 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.
|
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.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildDescribeDbClusterSnapshotsRequest.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 isn't 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 isn't
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 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 the
IncludeShared parameter. You can include public DB cluster snapshots with these results by
enabling the IncludePublic parameter.
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 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 the
IncludeShared parameter. You can include public DB cluster snapshots with these results
by enabling the IncludePublic parameter.
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)
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.
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.
DescribeDbClusterSnapshotsRequest.Builder filters(Filter... 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.
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.
DescribeDbClusterSnapshotsRequest.Builder filters(Consumer<Filter.Builder>... 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.
List.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 you can
retrieve the remaining results.
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 you
can retrieve the remaining results.
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)
A value that indicates 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. By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from another
Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
includeShared - A value that indicates 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.
By default, these snapshots are not included.
You can give an Amazon Web Services account permission to restore a manual DB cluster snapshot from
another Amazon Web Services account by the ModifyDBClusterSnapshotAttribute API action.
DescribeDbClusterSnapshotsRequest.Builder includePublic(Boolean includePublic)
A value that indicates 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.
includePublic - A value that indicates 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.
DescribeDbClusterSnapshotsRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderoverrideConfiguration - The override configuration.DescribeDbClusterSnapshotsRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.BuilderoverrideConfiguration in interface AwsRequest.BuilderbuilderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be
given.