@Generated(value="software.amazon.awssdk:codegen") public class DescribeDBSnapshotsRequest extends RDSRequest implements ToCopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>
Modifier and Type | Class and Description |
---|---|
static interface |
DescribeDBSnapshotsRequest.Builder |
Modifier and Type | Method and Description |
---|---|
static DescribeDBSnapshotsRequest.Builder |
builder() |
String |
dbInstanceIdentifier()
The ID of the DB instance to retrieve the list of DB snapshots for.
|
String |
dbSnapshotIdentifier()
A specific DB snapshot identifier to describe.
|
boolean |
equals(Object obj) |
List<Filter> |
filters()
This parameter is not currently supported.
|
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz)
Used to retrieve the value of a field from any class that extends
SdkRequest . |
int |
hashCode() |
Boolean |
includePublic()
True to include manual DB snapshots that are public and can be copied or restored by any AWS account, and
otherwise false.
|
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.
|
String |
marker()
An optional pagination token provided by a previous
DescribeDBSnapshots request. |
Integer |
maxRecords()
The maximum number of records to include in the response.
|
static Class<? extends DescribeDBSnapshotsRequest.Builder> |
serializableBuilderClass() |
String |
snapshotType()
The type of snapshots to be returned.
|
DescribeDBSnapshotsRequest.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
requestOverrideConfig
copy
public 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.
DBSnapshotIdentifier
. This parameter is not case-sensitive.
Constraints:
If supplied, must match the identifier of an existing DBInstance.
public 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.
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.
public 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
.
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
.
public List<Filter> filters()
This parameter is not currently supported.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
public 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
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.
public 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
.
DescribeDBSnapshots
request. If this
parameter is specified, the response includes only records beyond the marker, up to the value specified
by MaxRecords
.public 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.
false
.
You can give an AWS account permission to restore a manual DB snapshot from another AWS account by using the ModifyDBSnapshotAttribute API action.
public 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.
You can share a manual DB snapshot as public by using the ModifyDBSnapshotAttribute API.
public DescribeDBSnapshotsRequest.Builder toBuilder()
ToCopyableBuilder
toBuilder
in interface ToCopyableBuilder<DescribeDBSnapshotsRequest.Builder,DescribeDBSnapshotsRequest>
toBuilder
in class RDSRequest
public static DescribeDBSnapshotsRequest.Builder builder()
public static Class<? extends DescribeDBSnapshotsRequest.Builder> serializableBuilderClass()
public <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
SdkRequest
SdkRequest
. The field name
specified should match the member name from the corresponding service-2.json model specified in the
codegen-resources folder for a given service. The class specifies what class to cast the returned value to.
If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class)
method will
again be available.getValueForField
in class SdkRequest
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.