copy-snapshot¶
Description¶
Makes a copy of an existing snapshot.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
Synopsis¶
copy-snapshot
--source-snapshot-name <value>
--target-snapshot-name <value>
[--target-bucket <value>]
[--kms-key-id <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
Options¶
--source-snapshot-name (string)
The name of an existing snapshot from which to make a copy.
--target-snapshot-name (string)
A name for the snapshot copy. MemoryDB does not permit overwriting a snapshot, therefore this name must be unique within its context - MemoryDB or an Amazon S3 bucket if exporting.
--target-bucket (string)
The Amazon S3 bucket to which the snapshot is exported. This parameter is used only when exporting a snapshot for external access. When using this parameter to export a snapshot, be sure MemoryDB has the needed permissions to this S3 bucket. For more information, see Step 2: Grant MemoryDB Access to Your Amazon S3 Bucket .
--kms-key-id (string)
The ID of the KMS key used to encrypt the target 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 | --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)
Represents a copy of an entire cluster as of the time when the snapshot was taken.
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