Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

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.

[ aws . docdb ]

copy-db-cluster-snapshot

Description

Copies a snapshot of a cluster.

To copy a cluster snapshot from a shared manual cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared cluster snapshot. You can only copy a shared DB cluster snapshot, whether encrypted or not, in the same AWS Region.

To cancel the copy operation after it is in progress, delete the target cluster snapshot identified by TargetDBClusterSnapshotIdentifier while that cluster snapshot is in the copying status.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  copy-db-cluster-snapshot
--source-db-cluster-snapshot-identifier <value>
--target-db-cluster-snapshot-identifier <value>
[--kms-key-id <value>]
[--pre-signed-url <value>]
[--copy-tags | --no-copy-tags]
[--tags <value>]
[--source-region <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--source-db-cluster-snapshot-identifier (string)

The identifier of the cluster snapshot to copy. This parameter is not case sensitive.

Constraints:

  • Must specify a valid system snapshot in the available state.
  • If the source snapshot is in the same AWS Region as the copy, specify a valid snapshot identifier.
  • If the source snapshot is in a different AWS Region than the copy, specify a valid cluster snapshot ARN.

Example: my-cluster-snapshot1

--target-db-cluster-snapshot-identifier (string)

The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.
  • The first character must be a letter.
  • Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster-snapshot2

--kms-key-id (string)

The AWS KMS key ID for an encrypted cluster snapshot. The AWS KMS key ID is the Amazon Resource Name (ARN), AWS KMS key identifier, or the AWS KMS key alias for the AWS KMS encryption key.

If you copy an encrypted cluster snapshot from your AWS account, you can specify a value for KmsKeyId to encrypt the copy with a new AWS KMS encryption key. If you don't specify a value for KmsKeyId , then the copy of the cluster snapshot is encrypted with the same AWS KMS key as the source cluster snapshot.

If you copy an encrypted cluster snapshot that is shared from another AWS account, then you must specify a value for KmsKeyId .

To copy an encrypted cluster snapshot to another AWS Region, set KmsKeyId to the AWS KMS key ID that you want to use to encrypt the copy of the cluster snapshot in the destination Region. AWS KMS encryption keys are specific to the AWS Region that they are created in, and you can't use encryption keys from one AWS Region in another AWS Region.

If you copy an unencrypted cluster snapshot and specify a value for the KmsKeyId parameter, an error is returned.

--pre-signed-url (string)

The URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API action in the AWS Region that contains the source cluster snapshot to copy. You must use the PreSignedUrl parameter when copying a cluster snapshot from another AWS Region.

If you are using an AWS SDK tool or the AWS CLI, you can specify SourceRegion (or --source-region for the AWS CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a pre-signed URL that is a valid request for the operation that can be executed in the source AWS Region.

The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source AWS Region that contains the cluster snapshot to be copied. The presigned URL request must contain the following parameter values:

  • SourceRegion - The ID of the region that contains the snapshot to be copied.
  • SourceDBClusterSnapshotIdentifier - The identifier for the the encrypted cluster snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source AWS Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 AWS Region, then your SourceDBClusterSnapshotIdentifier looks something like the following: arn:aws:rds:us-east-1:12345678012:sample-cluster:sample-cluster-snapshot .
  • TargetDBClusterSnapshotIdentifier - The identifier for the new cluster snapshot to be created. This parameter isn't case sensitive.

--copy-tags | --no-copy-tags (boolean)

Set to true to copy all tags from the source cluster snapshot to the target cluster snapshot, and otherwise false . The default is false .

--tags (list)

The tags to be assigned to the cluster snapshot.

(structure)

Metadata assigned to an Amazon DocumentDB resource consisting of a key-value pair.

Key -> (string)

The required name of the tag. The string value can be from 1 to 128 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

Value -> (string)

The optional value of the tag. The string value can be from 1 to 256 Unicode characters in length and can't be prefixed with "aws:" or "rds:". The string can contain only the set of Unicode letters, digits, white space, '_', '.', '/', '=', '+', '-' (Java regex: "^([\p{L}\p{Z}\p{N}_.:/=+\-]*)$").

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--source-region (string)

The ID of the region that contains the snapshot to be copied.

--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.

Examples

To create a copy of a snapshot

The following copy-db-cluster-snapshot example makes a copy of sample-cluster-snapshot named sample-cluster-snapshot-copy. The copy has all the tags of the original plus a new tag with the key name CopyNumber.

aws docdb copy-db-cluster-snapshot \
    --source-db-cluster-snapshot-identifier sample-cluster-snapshot \
    --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
    --copy-tags \
    --tags Key="CopyNumber",Value="1"

This command produces no output.

For more information, see Copying a Cluster Snapshot in the Amazon DocumentDB Developer Guide.

Output

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 is true , the AWS 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.