Deletes a cluster snapshot. If the snapshot is being copied, the copy operation is terminated.
Note
The cluster snapshot must be in the available
state to be deleted.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
delete-db-cluster-snapshot
--db-cluster-snapshot-identifier <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
--db-cluster-snapshot-identifier
(string)
The identifier of the cluster snapshot to delete.
Constraints: Must be the name of an existing cluster snapshot in the
available
state.
--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
.
--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 delete an Amazon DocumentDB cluster snapshot
The following delete-db-cluster-snapshot
example deletes the Amazon DocumentDB cluster snapshot sample-cluster-snapshot
.
aws docdb delete-db-cluster-snapshot \
--db-cluster-snapshot-identifier sample-cluster-snapshot
Output:
{
"DBClusterSnapshot": {
"DBClusterIdentifier": "sample-cluster",
"AvailabilityZones": [
"us-west-2a",
"us-west-2b",
"us-west-2c",
"us-west-2d"
],
"DBClusterSnapshotIdentifier": "sample-cluster-snapshot",
"VpcId": "vpc-91280df6",
"DBClusterSnapshotArn": "arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot",
"EngineVersion": "3.6.0",
"Engine": "docdb",
"SnapshotCreateTime": "2019-03-18T18:27:14.794Z",
"Status": "available",
"MasterUsername": "master-user",
"ClusterCreateTime": "2019-03-15T20:29:58.836Z",
"PercentProgress": 100,
"StorageEncrypted": false,
"SnapshotType": "manual",
"Port": 0
}
}
For more information, see Deleting a Cluster Snapshot in the Amazon DocumentDB Developer Guide.
DBClusterSnapshot -> (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.