delete-snapshot¶
Description¶
Deletes an existing snapshot. When you receive a successful response from this operation, MemoryDB immediately begins deleting the snapshot; you cannot cancel or revert this operation.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
delete-snapshot
--snapshot-name <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--snapshot-name (string)
The name of the snapshot to delete
--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.
Output¶
Snapshot -> (structure)
The snapshot object that has been deleted.
Name -> (string)
The name of the snapshot
Status -> (string)
The status of the snapshot. Valid values: creating | available | restoring | copying | deleting.
Source -> (string)
Indicates whether the snapshot is from an automatic backup (automated) or was created manually (manual).
KmsKeyId -> (string)
The ID of the KMS key used to encrypt the snapshot.
ARN -> (string)
The ARN (Amazon Resource Name) of the snapshot.
ClusterConfiguration -> (structure)
The configuration of the cluster from which the snapshot was taken
Name -> (string)
The name of the cluster
Description -> (string)
The description of the cluster configuration
NodeType -> (string)
The node type used for the cluster
EngineVersion -> (string)
The Redis engine version used by the cluster
MaintenanceWindow -> (string)
The specified maintenance window for the cluster
TopicArn -> (string)
The Amazon Resource Name (ARN) of the SNS notification topic for the cluster
Port -> (integer)
The port used by the cluster
ParameterGroupName -> (string)
The name of parameter group used by the cluster
SubnetGroupName -> (string)
The name of the subnet group used by the cluster
VpcId -> (string)
The ID of the VPC the cluster belongs to
SnapshotRetentionLimit -> (integer)
The snapshot retention limit set by the cluster
SnapshotWindow -> (string)
The snapshot window set by the cluster
NumShards -> (integer)
The number of shards in the cluster
Shards -> (list)
The list of shards in the cluster
(structure)
Provides details of a shard in a snapshot
Name -> (string)
The name of the shard
Configuration -> (structure)
The configuration details of the shard
Slots -> (string)
A string that specifies the keyspace for a particular node group. Keyspaces range from 0 to 16,383. The string is in the format startkey-endkey.
ReplicaCount -> (integer)
The number of read replica nodes in this shard.
Size -> (string)
The size of the shard’s snapshot
SnapshotCreationTime -> (timestamp)
The date and time that the shard’s snapshot was created