AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
Returns information about DB cluster snapshots. This API action supports pagination.
See also: AWS API Documentation
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 <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
--db-cluster-identifier
(string)
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 is not case-sensitive.Constraints:
- If supplied, must match the identifier of an existing DBCluster.
--db-cluster-snapshot-identifier
(string)
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.
--snapshot-type
(string)
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 Neptune for my Amazon account.manual
- Return all DB cluster snapshots that have been taken by my Amazon account.shared
- Return all manual DB cluster snapshots that have been shared to my Amazon 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 theIncludeShared
parameter totrue
. You can include public DB cluster snapshots with these results by setting theIncludePublic
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)
This type is not currently supported.
Name -> (string)
This parameter is not currently supported.Values -> (list)
This parameter is not currently supported.
(string)
Shorthand Syntax:
Name=string,Values=string,string ...
JSON Syntax:
[
{
"Name": "string",
"Values": ["string", ...]
}
...
]
--include-shared
| --no-include-shared
(boolean)
True to include shared manual DB cluster snapshots from other Amazon accounts that this Amazon account has been given permission to copy or restore, and otherwise false. The default is
false
.You can give an Amazon account permission to restore a manual DB cluster snapshot from another Amazon account by the ModifyDBClusterSnapshotAttribute API action.
--include-public
| --no-include-public
(boolean)
True to include manual DB cluster snapshots that are public and can be copied or restored by any Amazon account, and otherwise 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.
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--debug
(boolean)
Turn on debug logging.
--endpoint-url
(string)
Override command's default URL with the given URL.
--no-verify-ssl
(boolean)
By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.
--no-paginate
(boolean)
Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--query
(string)
A JMESPath query to use in filtering the response data.
--profile
(string)
Use a specific profile from your credential file.
--region
(string)
The region to use. Overrides config/env settings.
--version
(string)
Display the version of this tool.
--color
(string)
Turn on/off color output.
--no-sign-request
(boolean)
Do not sign requests. Credentials will not be loaded if this argument is provided.
--ca-bundle
(string)
The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.
--cli-read-timeout
(int)
The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.
--cli-connect-timeout
(int)
The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.
Marker -> (string)
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 byMaxRecords
.
DBClusterSnapshots -> (list)
Provides a list of DB cluster snapshots for the user.
(structure)
Contains the details for an Amazon Neptune DB cluster snapshot
This data type is used as a response element in the DescribeDBClusterSnapshots action.
AvailabilityZones -> (list)
Provides the list of EC2 Availability Zones that instances in the DB cluster snapshot can be restored in.
(string)
DBClusterSnapshotIdentifier -> (string)
Specifies the identifier for a DB cluster snapshot. Must match the identifier of an existing snapshot.
After you restore a DB cluster using a
DBClusterSnapshotIdentifier
, you must specify the sameDBClusterSnapshotIdentifier
for any future updates to the DB cluster. When you specify this property for an update, the DB cluster is not restored from the snapshot again, and the data in the database is not changed.However, if you don't specify the
DBClusterSnapshotIdentifier
, an empty DB cluster is created, and the original DB cluster is deleted. If you specify a property that is different from the previous snapshot restore property, the DB cluster is restored from the snapshot specified by theDBClusterSnapshotIdentifier
, and the original DB cluster is deleted.DBClusterIdentifier -> (string)
Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.SnapshotCreateTime -> (timestamp)
Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).Engine -> (string)
Specifies the name of the database engine.AllocatedStorage -> (integer)
Specifies the allocated storage size in gibibytes (GiB).Status -> (string)
Specifies the status of this DB cluster snapshot.Port -> (integer)
Specifies the port that the DB cluster was listening on at the time of the snapshot.VpcId -> (string)
Provides the VPC ID associated with the DB cluster snapshot.ClusterCreateTime -> (timestamp)
Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).MasterUsername -> (string)
Not supported by Neptune.EngineVersion -> (string)
Provides the version of the database engine for this DB cluster snapshot.LicenseModel -> (string)
Provides the license model information for this DB cluster snapshot.SnapshotType -> (string)
Provides the type of the DB cluster snapshot.PercentProgress -> (integer)
Specifies the percentage of the estimated data that has been transferred.StorageEncrypted -> (boolean)
Specifies whether the DB cluster snapshot is encrypted.KmsKeyId -> (string)
IfStorageEncrypted
is true, the Amazon KMS key identifier for the encrypted DB cluster snapshot.DBClusterSnapshotArn -> (string)
The Amazon Resource Name (ARN) for the DB cluster snapshot.SourceDBClusterSnapshotArn -> (string)
If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.IAMDatabaseAuthenticationEnabled -> (boolean)
True if mapping of Amazon Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.StorageType -> (string)
The storage type associated with the DB cluster snapshot.