Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).
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.
Creates a copy of an entire cluster at a specific moment in time.
See also: AWS API Documentation
See 'aws help' for descriptions of global parameters.
create-snapshot
--cluster-name <value>
--snapshot-name <value>
[--kms-key-id <value>]
[--tags <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
--cluster-name
(string)
The snapshot is created from this cluster.
--snapshot-name
(string)
A name for the snapshot being created.
--kms-key-id
(string)
The ID of the KMS key used to encrypt the snapshot.
--tags
(list)
A list of tags to be added to this resource. A tag is a key-value pair. A tag key must be accompanied by a tag value, although null is accepted.
(structure)
A tag that can be added to an MemoryDB resource. Tags are composed of a Key/Value pair. You can use tags to categorize and track all your MemoryDB resources. When you add or remove tags on clusters, those actions will be replicated to all nodes in the cluster. A tag with a null Value is permitted. For more information, see Tagging your MemoryDB resources
Key -> (string)
The key for the tag. May not be null.Value -> (string)
The tag's value. May be null.
Shorthand Syntax:
Key=string,Value=string ...
JSON Syntax:
[
{
"Key": "string",
"Value": "string"
}
...
]
--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.
--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.
See 'aws help' for descriptions of global parameters.
Snapshot -> (structure)
The newly-created snapshot.
Name -> (string)
The name of the snapshotStatus -> (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 clusterDescription -> (string)
The description of the cluster configurationNodeType -> (string)
The node type used for the clusterEngineVersion -> (string)
The Redis engine version used by the clusterMaintenanceWindow -> (string)
The specified maintenance window for the clusterTopicArn -> (string)
The Amazon Resource Name (ARN) of the SNS notification topic for the clusterPort -> (integer)
The port used by the clusterParameterGroupName -> (string)
The name of parameter group used by the clusterSubnetGroupName -> (string)
The name of the subnet group used by the clusterVpcId -> (string)
The ID of the VPC the cluster belongs toSnapshotRetentionLimit -> (integer)
The snapshot retention limit set by the clusterSnapshotWindow -> (string)
The snapshot window set by the clusterNumShards -> (integer)
The number of shards in the clusterShards -> (list)
The list of shards in the cluster
(structure)
Provides details of a shard in a snapshot
Name -> (string)
The name of the shardConfiguration -> (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 snapshotSnapshotCreationTime -> (timestamp)
The date and time that the shard's snapshot was created