CopySnapshot
Makes a copy of an existing snapshot.
Request Syntax
{
"KmsKeyId": "string",
"SourceSnapshotName": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"TargetBucket": "string",
"TargetSnapshotName": "string"
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- KmsKeyId
-
The ID of the KMS key used to encrypt the target snapshot.
Type: String
Length Constraints: Maximum length of 2048.
Required: No
- SourceSnapshotName
-
The name of an existing snapshot from which to make a copy.
Type: String
Required: Yes
- Tags
-
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.
Type: Array of Tag objects
Array Members: Maximum number of 200 items.
Required: No
- TargetBucket
-
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.
Type: String
Length Constraints: Maximum length of 255.
Pattern:
^[A-Za-z0-9._-]+$Required: No
- TargetSnapshotName
-
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.
Type: String
Required: Yes
Response Syntax
{
"Snapshot": {
"ARN": "string",
"ClusterConfiguration": {
"Description": "string",
"Engine": "string",
"EngineVersion": "string",
"MaintenanceWindow": "string",
"MultiRegionClusterName": "string",
"MultiRegionParameterGroupName": "string",
"Name": "string",
"NodeType": "string",
"NumShards": number,
"ParameterGroupName": "string",
"Port": number,
"Shards": [
{
"Configuration": {
"ReplicaCount": number,
"Slots": "string"
},
"Name": "string",
"Size": "string",
"SnapshotCreationTime": number
}
],
"SnapshotRetentionLimit": number,
"SnapshotWindow": "string",
"SubnetGroupName": "string",
"TopicArn": "string",
"VpcId": "string"
},
"DataTiering": "string",
"KmsKeyId": "string",
"Name": "string",
"Source": "string",
"Status": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterCombinationException
-
HTTP Status Code: 400
- InvalidParameterValueException
-
HTTP Status Code: 400
- InvalidSnapshotStateFault
-
HTTP Status Code: 400
- ServiceLinkedRoleNotFoundFault
-
HTTP Status Code: 400
- SnapshotAlreadyExistsFault
-
HTTP Status Code: 400
- SnapshotNotFoundFault
-
HTTP Status Code: 400
- SnapshotQuotaExceededFault
-
HTTP Status Code: 400
- TagQuotaPerResourceExceeded
-
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
