public static interface DescribeDBSnapshotsRequest.Builder extends RDSRequest.Builder, CopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>
Modifier and Type | Method and Description |
---|---|
DescribeDBSnapshotsRequest.Builder |
dbInstanceIdentifier(String dbInstanceIdentifier)
The ID of the DB instance to retrieve the list of DB snapshots for.
|
DescribeDBSnapshotsRequest.Builder |
dbSnapshotIdentifier(String dbSnapshotIdentifier)
A specific DB snapshot identifier to describe.
|
DescribeDBSnapshotsRequest.Builder |
filters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeDBSnapshotsRequest.Builder |
filters(Filter... filters)
This parameter is not currently supported.
|
DescribeDBSnapshotsRequest.Builder |
includePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and
otherwise false.
|
DescribeDBSnapshotsRequest.Builder |
includeShared(Boolean includeShared)
True to include shared manual DB snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, and otherwise false.
|
DescribeDBSnapshotsRequest.Builder |
marker(String marker)
An optional pagination token provided by a previous
DescribeDBSnapshots request. |
DescribeDBSnapshotsRequest.Builder |
maxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeDBSnapshotsRequest.Builder |
requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
Add an optional request override configuration.
|
DescribeDBSnapshotsRequest.Builder |
snapshotType(String snapshotType)
The type of snapshots to be returned.
|
build
requestOverrideConfig, requestOverrideConfig
copy
apply, build
DescribeDBSnapshotsRequest.Builder dbInstanceIdentifier(String dbInstanceIdentifier)
The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in
conjunction with DBSnapshotIdentifier
. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
dbInstanceIdentifier
- The ID of the DB instance to retrieve the list of DB snapshots for. This parameter can't be used in
conjunction with DBSnapshotIdentifier
. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
DescribeDBSnapshotsRequest.Builder dbSnapshotIdentifier(String dbSnapshotIdentifier)
A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be
specified.
dbSnapshotIdentifier
- A specific DB snapshot identifier to describe. This parameter can't be used in conjunction with
DBInstanceIdentifier
. This value is stored as a lowercase string.
Constraints:
If supplied, must match the identifier of an existing DBSnapshot.
If this identifier is for an automated snapshot, the SnapshotType
parameter must also be
specified.
DescribeDBSnapshotsRequest.Builder snapshotType(String snapshotType)
The type of snapshots to be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for my AWS
account.
manual
- Return all DB snapshots that have been taken by my AWS account.
shared
- Return all manual DB snapshots that have been shared to my AWS account.
public
- Return all DB snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual snapshots are
returned. Shared and public DB snapshots are not included in the returned results by default. You can include
shared snapshots with these results by setting the IncludeShared
parameter to true
.
You can include public 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 snapshots to be returned. You can specify one of the following values:
automated
- Return all DB snapshots that have been automatically taken by Amazon RDS for
my AWS account.
manual
- Return all DB snapshots that have been taken by my AWS account.
shared
- Return all manual DB snapshots that have been shared to my AWS account.
public
- Return all DB snapshots that have been marked as public.
If you don't specify a SnapshotType
value, then both automated and manual snapshots are
returned. Shared and public DB snapshots are not included in the returned results by default. You can
include shared snapshots with these results by setting the IncludeShared
parameter to
true
. You can include public 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
.
DescribeDBSnapshotsRequest.Builder filters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.DescribeDBSnapshotsRequest.Builder filters(Filter... filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.DescribeDBSnapshotsRequest.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.
DescribeDBSnapshotsRequest.Builder marker(String marker)
An optional pagination token provided by a previous DescribeDBSnapshots
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 DescribeDBSnapshots
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value
specified by MaxRecords
.DescribeDBSnapshotsRequest.Builder includeShared(Boolean includeShared)
True to include shared manual DB 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 snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
includeShared
- True to include shared manual DB 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 snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
DescribeDBSnapshotsRequest.Builder includePublic(Boolean includePublic)
True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and otherwise false. The default is false.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
includePublic
- True to include manual DB snapshots that are public and can be copied or restored by any AWS account,
and otherwise false. The default is false.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
DescribeDBSnapshotsRequest.Builder requestOverrideConfig(AwsRequestOverrideConfig awsRequestOverrideConfig)
AwsRequest.Builder
requestOverrideConfig
in interface AwsRequest.Builder
awsRequestOverrideConfig
- The override configuration.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.