public class DescribeDBClusterSnapshotsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
DescribeDBClusterSnapshotsRequest() |
Modifier and Type | Method and Description |
---|---|
DescribeDBClusterSnapshotsRequest |
clone()
Creates a shallow clone of this request.
|
boolean |
equals(Object obj) |
String |
getDBClusterIdentifier()
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for.
|
String |
getDBClusterSnapshotIdentifier()
A specific DB cluster snapshot identifier to describe.
|
List<Filter> |
getFilters()
This parameter is not currently supported.
|
Boolean |
getIncludePublic()
Set this value to
true to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to false . |
Boolean |
getIncludeShared()
Set this value to
true to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
false . |
String |
getMarker()
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
Integer |
getMaxRecords()
The maximum number of records to include in the response.
|
String |
getSnapshotType()
The type of DB cluster snapshots to be returned.
|
int |
hashCode() |
Boolean |
isIncludePublic()
Set this value to
true to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to false . |
Boolean |
isIncludeShared()
Set this value to
true to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
false . |
void |
setDBClusterIdentifier(String dBClusterIdentifier)
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for.
|
void |
setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe.
|
void |
setFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
void |
setIncludePublic(Boolean includePublic)
Set this value to
true to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to false . |
void |
setIncludeShared(Boolean includeShared)
Set this value to
true to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
false . |
void |
setMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
void |
setMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
void |
setSnapshotType(String snapshotType)
The type of DB cluster snapshots to be returned.
|
String |
toString()
Returns a string representation of this object; useful for testing and
debugging.
|
DescribeDBClusterSnapshotsRequest |
withDBClusterIdentifier(String dBClusterIdentifier)
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for.
|
DescribeDBClusterSnapshotsRequest |
withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe.
|
DescribeDBClusterSnapshotsRequest |
withFilters(Collection<Filter> filters)
This parameter is not currently supported.
|
DescribeDBClusterSnapshotsRequest |
withFilters(Filter... filters)
This parameter is not currently supported.
|
DescribeDBClusterSnapshotsRequest |
withIncludePublic(Boolean includePublic)
Set this value to
true to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to false . |
DescribeDBClusterSnapshotsRequest |
withIncludeShared(Boolean includeShared)
Set this value to
true to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
false . |
DescribeDBClusterSnapshotsRequest |
withMarker(String marker)
An optional pagination token provided by a previous
DescribeDBClusterSnapshots request. |
DescribeDBClusterSnapshotsRequest |
withMaxRecords(Integer maxRecords)
The maximum number of records to include in the response.
|
DescribeDBClusterSnapshotsRequest |
withSnapshotType(String snapshotType)
The type of DB cluster snapshots to be returned.
|
getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setDBClusterIdentifier(String dBClusterIdentifier)
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter cannot be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
dBClusterIdentifier
- The ID of the DB cluster to retrieve the list of DB cluster
snapshots for. This parameter cannot be used in conjunction with
the DBClusterSnapshotIdentifier
parameter. This
parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public String getDBClusterIdentifier()
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter cannot be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
DBClusterSnapshotIdentifier
parameter. This
parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public DescribeDBClusterSnapshotsRequest withDBClusterIdentifier(String dBClusterIdentifier)
The ID of the DB cluster to retrieve the list of DB cluster snapshots
for. This parameter cannot be used in conjunction with the
DBClusterSnapshotIdentifier
parameter. This parameter is not
case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
dBClusterIdentifier
- The ID of the DB cluster to retrieve the list of DB cluster
snapshots for. This parameter cannot be used in conjunction with
the DBClusterSnapshotIdentifier
parameter. This
parameter is not case-sensitive.
Constraints:
Must contain from 1 to 63 alphanumeric characters or hyphens
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
public void setDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe. This parameter
cannot be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 cannot be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored
as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
public String getDBClusterSnapshotIdentifier()
A specific DB cluster snapshot identifier to describe. This parameter
cannot be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
DBClusterIdentifier
parameter. This value is stored
as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
public DescribeDBClusterSnapshotsRequest withDBClusterSnapshotIdentifier(String dBClusterSnapshotIdentifier)
A specific DB cluster snapshot identifier to describe. This parameter
cannot be used in conjunction with the DBClusterIdentifier
parameter. This value is stored as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
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 cannot be used in conjunction with the
DBClusterIdentifier
parameter. This value is stored
as a lowercase string.
Constraints:
Must be 1 to 255 alphanumeric characters
First character must be a letter
Cannot end with a hyphen or contain two consecutive hyphens
If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
public void setSnapshotType(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
.
public String getSnapshotType()
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
.
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
.
public DescribeDBClusterSnapshotsRequest withSnapshotType(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
.
public List<Filter> getFilters()
This parameter is not currently supported.
public void setFilters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.public DescribeDBClusterSnapshotsRequest withFilters(Filter... filters)
This parameter is not currently supported.
NOTE: This method appends the values to the existing list (if
any). Use setFilters(java.util.Collection)
or
withFilters(java.util.Collection)
if you want to override the
existing values.
filters
- This parameter is not currently supported.public DescribeDBClusterSnapshotsRequest withFilters(Collection<Filter> filters)
This parameter is not currently supported.
filters
- This parameter is not currently supported.public void setMaxRecords(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.
public Integer getMaxRecords()
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 DescribeDBClusterSnapshotsRequest withMaxRecords(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.
public void setMarker(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
.public String getMarker()
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
.
DescribeDBClusterSnapshots
request. If this
parameter is specified, the response includes only records beyond
the marker, up to the value specified by MaxRecords
.public DescribeDBClusterSnapshotsRequest withMarker(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
.public void setIncludeShared(Boolean includeShared)
Set this value to true
to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
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
- Set this value to true
to include shared manual DB
cluster snapshots from other AWS accounts that this AWS account
has been given permission to copy or restore, otherwise set this
value to 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.
public Boolean getIncludeShared()
Set this value to true
to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
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.
true
to include shared manual DB
cluster snapshots from other AWS accounts that this AWS account
has been given permission to copy or restore, otherwise set this
value to 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.
public DescribeDBClusterSnapshotsRequest withIncludeShared(Boolean includeShared)
Set this value to true
to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
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
- Set this value to true
to include shared manual DB
cluster snapshots from other AWS accounts that this AWS account
has been given permission to copy or restore, otherwise set this
value to 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.
public Boolean isIncludeShared()
Set this value to true
to include shared manual DB cluster
snapshots from other AWS accounts that this AWS account has been given
permission to copy or restore, otherwise set this value to
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.
true
to include shared manual DB
cluster snapshots from other AWS accounts that this AWS account
has been given permission to copy or restore, otherwise set this
value to 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.
public void setIncludePublic(Boolean includePublic)
Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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
- Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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.
public Boolean getIncludePublic()
Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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.
true
to include manual DB cluster
snapshots that are public and can be copied or restored by any
AWS account, otherwise set this value to 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.
public DescribeDBClusterSnapshotsRequest withIncludePublic(Boolean includePublic)
Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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
- Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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.
public Boolean isIncludePublic()
Set this value to true
to include manual DB cluster
snapshots that are public and can be copied or restored by any AWS
account, otherwise set this value to 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.
true
to include manual DB cluster
snapshots that are public and can be copied or restored by any
AWS account, otherwise set this value to 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.
public String toString()
toString
in class Object
Object.toString()
public DescribeDBClusterSnapshotsRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.