Returns information about cluster snapshots. This API operation supports pagination.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
describe-db-cluster-snapshots
is a paginated operation. Multiple API calls may be issued in order to retrieve the entire data set of results. You can disable pagination by providing the --no-paginate
argument.
When using --output text
and the --query
argument on a paginated response, the --query
argument must extract data from the results of the following query expressions: DBClusterSnapshots
describe-db-cluster-snapshots
[--db-cluster-identifier <value>]
[--db-cluster-snapshot-identifier <value>]
[--snapshot-type <value>]
[--filters <value>]
[--include-shared | --no-include-shared]
[--include-public | --no-include-public]
[--cli-input-json | --cli-input-yaml]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
--db-cluster-identifier
(string)
The ID of the cluster to retrieve the list of cluster snapshots for. This parameter can’t be used with the
DBClusterSnapshotIdentifier
parameter. This parameter is not case sensitive.Constraints:
If provided, must match the identifier of an existing
DBCluster
.
--db-cluster-snapshot-identifier
(string)
A specific cluster snapshot identifier to describe. This parameter can’t be used with the
DBClusterIdentifier
parameter. This value is stored as a lowercase string.Constraints:
If provided, must match the identifier of an existing
DBClusterSnapshot
.If this identifier is for an automated snapshot, the
SnapshotType
parameter must also be specified.
--snapshot-type
(string)
The type of cluster snapshots to be returned. You can specify one of the following values:
automated
- Return all cluster snapshots that Amazon DocumentDB has automatically created for your account.
manual
- Return all cluster snapshots that you have manually created for your account.
shared
- Return all manual cluster snapshots that have been shared to your account.
public
- Return all cluster snapshots that have been marked as public.If you don’t specify a
SnapshotType
value, then both automated and manual cluster snapshots are returned. You can include shared cluster snapshots with these results by setting theIncludeShared
parameter totrue
. You can include public cluster snapshots with these results by setting the``IncludePublic`` parameter totrue
.The
IncludeShared
andIncludePublic
parameters don’t apply forSnapshotType
values ofmanual
orautomated
. TheIncludePublic
parameter doesn’t apply whenSnapshotType
is set toshared
. TheIncludeShared
parameter doesn’t apply whenSnapshotType
is set topublic
.
--filters
(list)
This parameter is not currently supported.
(structure)
A named set of filter values, used to return a more specific list of results. You can use a filter to match a set of resources by specific criteria, such as IDs.
Wildcards are not supported in filters.
Name -> (string)
The name of the filter. Filter names are case sensitive.
Values -> (list)
One or more filter values. Filter values are case sensitive.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--include-shared
| --no-include-shared
(boolean)
Set to
true
to include shared manual cluster snapshots from other accounts that this account has been given permission to copy or restore, and otherwisefalse
. The default isfalse
.
--include-public
| --no-include-public
(boolean)
Set to
true
to include manual cluster snapshots that are public and can be copied or restored by any account, and otherwisefalse
. The default isfalse
.
--cli-input-json
| --cli-input-yaml
(string)
Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml
.
--starting-token
(string)
A token to specify where to start paginating. This is the
NextToken
from a previously truncated response.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--page-size
(integer)
The size of each page to get in the AWS service call. This does not affect the number of items returned in the command’s output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.
For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--max-items
(integer)
The total number of items to return in the command’s output. If the total number of items available is more than the value specified, a
NextToken
is provided in the command’s output. To resume pagination, provide theNextToken
value in thestarting-token
argument of a subsequent command. Do not use theNextToken
response element directly outside of the AWS CLI.For usage examples, see Pagination in the AWS Command Line Interface User Guide .
--generate-cli-skeleton
(string)
Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input
, prints a sample input JSON that can be used as an argument for --cli-input-json
. Similarly, if provided yaml-input
it will print a sample input YAML that can be used with --cli-input-yaml
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
See ‘aws help’ for descriptions of global parameters.
To describe Amazon DocumentDB snapshots
The following describe-db-cluster-snapshots
example displays details for the Amazon DocumentDB snapshot sample-cluster-snapshot
.
aws docdb describe-db-cluster-snapshots \
--db-cluster-snapshot-identifier sample-cluster-snapshot
Output:
{
"DBClusterSnapshots": [
{
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c",
"us-west-2d"
],
"Status": "available",
"DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
"SnapshotCreateTime": "2019-03-15T20:41:26.515Z",
"SnapshotType": "manual",
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
"DBClusterIdentifier": "sample-cluster",
"MasterUsername": "master-user",
"StorageEncrypted": false,
"VpcId": "vpc-91280df6",
"EngineVersion": "3.6.0",
"PercentProgress": 100,
"Port": 0,
"Engine": "docdb",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z"
}
]
}
For more information, see DescribeDBClusterSnapshots in the Amazon DocumentDB Developer Guide.
Marker -> (string)
An optional pagination token provided by a previous request. If this parameter is specified, the response includes only records beyond the marker, up to the value specified by
MaxRecords
.
DBClusterSnapshots -> (list)
Provides a list of cluster snapshots.
(structure)
Detailed information about a cluster snapshot.
AvailabilityZones -> (list)
Provides the list of Amazon EC2 Availability Zones that instances in the cluster snapshot can be restored in.
(string)
DBClusterSnapshotIdentifier -> (string)
Specifies the identifier for the cluster snapshot.
DBClusterIdentifier -> (string)
Specifies the cluster identifier of the cluster that this cluster snapshot was created from.
SnapshotCreateTime -> (timestamp)
Provides the time when the snapshot was taken, in UTC.
Engine -> (string)
Specifies the name of the database engine.
Status -> (string)
Specifies the status of this cluster snapshot.
Port -> (integer)
Specifies the port that the cluster was listening on at the time of the snapshot.
VpcId -> (string)
Provides the virtual private cloud (VPC) ID that is associated with the cluster snapshot.
ClusterCreateTime -> (timestamp)
Specifies the time when the cluster was created, in Universal Coordinated Time (UTC).
MasterUsername -> (string)
Provides the master user name for the cluster snapshot.
EngineVersion -> (string)
Provides the version of the database engine for this cluster snapshot.
SnapshotType -> (string)
Provides the type of the cluster snapshot.
PercentProgress -> (integer)
Specifies the percentage of the estimated data that has been transferred.
StorageEncrypted -> (boolean)
Specifies whether the cluster snapshot is encrypted.
KmsKeyId -> (string)
If
StorageEncrypted
istrue
, the KMS key identifier for the encrypted cluster snapshot.DBClusterSnapshotArn -> (string)
The Amazon Resource Name (ARN) for the cluster snapshot.
SourceDBClusterSnapshotArn -> (string)
If the cluster snapshot was copied from a source cluster snapshot, the ARN for the source cluster snapshot; otherwise, a null value.