Copying Amazon DocumentDB Cluster Snapshots

In Amazon DocumentDB, you can copy manual and automatic snapshots within the same AWS Region or to a different AWS Region within the same account. You can also share snapshots owned by other AWS accounts in the same AWS region. However, you can’t copy a cluster snapshot across AWS Regions and AWS accounts in a single step. These actions must be performed individually.

As an alternative to copying, you can also share manual snapshots with other AWS accounts. For more information, see Sharing Amazon DocumentDB Cluster Snapshots.

Note

Amazon DocumentDB bills you based upon the amount of backup and snapshot data you keep and the period of time that you keep it. For more information about the storage associated with Amazon DocumentDB backups and snapshots, see Understanding Backup Storage Usage. For pricing information about Amazon DocumentDB storage, see Amazon DocumentDB Pricing.

Copying Shared Snapshots

You can copy snapshots shared to you by other AWS accounts. If you are copying an encrypted snapshot that has been shared from another AWS account, you must have access to the AWS KMS encryption key that was used to encrypt the snapshot.

You can only copy a shared snapshot in the same AWS Region, whether the snapshot is encrypted or not. For more information, see Handling Encryption.

Copying Snapshots Across AWS Regions

When you copy a snapshot to an AWS Region that is different from the source snapshot’s AWS Region, each copy is a full snapshot. A full snapshot copy contains all of the data and metadata required to restore the Amazon DocumentDB cluster.

Depending on the AWS Regions involved and the amount of data to be copied, a cross-region snapshot copy can take hours to complete. In some cases, there might be a large number of cross-region snapshot copy requests from a given source AWS Region. In these cases, Amazon DocumentDB might put new cross-region copy requests from that source AWS Region into a queue until some in-progress copies complete. No progress information is displayed about copy requests while they are in the queue. Progress information is displayed when the copy starts.

Limitations

The following are some limitations when you copy snapshots:

  • If you delete a source snapshot before the target snapshot becomes available, the snapshot copy may fail. Verify that the target snapshot has a status of AVAILABLE before you delete a source snapshot.

  • You can have up to five snapshot copy requests in progress to a single destination Region per account.

  • Depending on the regions involved and the amount of data to be copied, a cross-region snapshot copy can take hours to complete. For more information, see Copying Snapshots Across AWS Regions.

Handling Encryption

You can copy a snapshot that has been encrypted using an AWS KMS encryption key. If you copy an encrypted snapshot, the copy of the snapshot must also be encrypted. If you copy an encrypted snapshot within the same AWS Region, you can encrypt the copy with the same AWS KMS encryption key as the original snapshot, or you can specify a different AWS KMS encryption key. If you copy an encrypted snapshot across Regions, you can’t use the same KMS encryption key for the copy as used for the source snapshot, because AWS KMS keys are Region-specific. Instead, you must specify an AWS KMS key valid in the destination AWS Region.

The source snapshot remains encrypted throughout the copy process. For more information, see Data Protection in Amazon DocumentDB.

Note

For Amazon DocumentDB cluster snapshots, you can’t encrypt an unencrypted cluster snapshot when you copy the snapshot.

Parameter Group Considerations

When you copy a snapshot across Regions, the copy doesn’t include the parameter group used by the original Amazon DocumentDB cluster. When you restore a snapshot to create a new cluster, that cluster gets the default parameter group for the AWS Region it is created in. To give the new cluster the same parameters as the original, you must do the following:

  1. In the destination AWS Region, create an Amazon DocumentDB cluster parameter group with the same settings as the original cluster. If one already exists in the new AWS Region, you can use that one.

  2. After you restore the snapshot in the destination AWS Region, modify the new Amazon DocumentDB cluster and add the new or existing parameter group from the previous step. For more information, see Modifying an Amazon DocumentDB Cluster.

Copying a Cluster Snapshot

You can copy an Amazon DocumentDB cluster using the AWS Management Console or the AWS CLI, as follows.

To make a copy of a cluster snapshot using the AWS Management Console, complete the following steps. This procedure works for copying encrypted or unencrypted cluster snapshots, in the same AWS Region or across Regions.

  1. Sign in to the AWS Management Console, and open the Amazon DocumentDB console at https://console.aws.amazon.com/docdb.

  2. In the navigation pane, choose Snapshots, and then choose the button to the left of the snapshot that you want to copy.

    Tip

    If you don’t see the navigation pane on the left side of your screen, choose the menu icon (Copying a Cluster Snapshot - 图1) in the upper-left corner of the page.

  3. From the Actions menu, choose Copy.

  4. In the resulting Make Copy of cluster snapshot page, complete the Settings section.

    1. Destination Region — Optional. To copy the cluster snapshot to a different AWS Region, choose that AWS Region for Destination Region.

    2. New snapshot identifier — Enter a name for the new snapshot.

      Target snapshot naming constraints:

      • Cannot be the name of an existing snapshot.

      • Length is [1—63] letters, numbers, or hyphens.

      • First character must be a letter.

      • Cannot end with a hyphen or contain two consecutive hyphens.

      • Must be unique for all clusters across Amazon RDS, Neptune, and Amazon DocumentDB per AWS account, per Region.

    3. Copy tags — To copy any tags you have on your source snapshot to your snapshot copy, choose Copy tags.

  5. Complete the Encryption-at-rest section.

    1. Encryption at rest — If your snapshot is encrypted, these options are not available to you because you cannot create an unencrypted copy from an encrypted snapshot. If your snapshot is not encrypted, choose one of the following:

      • To encrypt all your cluster’s data, choose Enable encryption-at-rest. If you choose this option, you must designate a Master key.

      • To not encrypt your cluster’s data, choose Disable encryption-at-rest. If you choose this option, your snapshot’s copy data will not be encrypted, and you are finished with the encryption section.

    2. Master key — From the drop-down list, choose one of the following:

      • (default) aws/rds — The account number and AWS KMS key ID are listed following this option.

      • <some-key-name> — If you created a key, it is listed and available for you to choose.

      • Enter a key ARN — In the ARN box, enter the Amazon Resource Name (ARN) for your AWS KMS key. The format of the ARN is arn:aws:kms:<region>:<accountID>:key/<key-id> .

  6. To make a copy of the selected snapshot, choose Copy snapshot. Alternatively, you can choose Cancel to not make a copy of the snapshot.

To make a copy of an unencrypted cluster snapshot using the AWS CLI, use the copy-db-cluster-snapshot operation with the following parameters. If you are copying the snapshot to another AWS Region, run the command in the AWS Region to which the snapshot will be copied.

  • --source-db-cluster-snapshot-identifier — Required. The identifier of the cluster snapshot to make a copy of. The cluster snapshot must exist and be in the available state. If you are copying the snapshot to another AWS region, this identifier must be in the ARN format for the source AWS region. This parameter is not case sensitive.

  • --target-db-cluster-snapshot-identifier — Required. The identifier of the new cluster snapshot to create from the source cluster snapshot. This parameter is not case sensitive.

    Target snapshot naming constraints:

    • Cannot be the name of an existing snapshot.

    • Length is [1—63] letters, numbers, or hyphens.

    • First character must be a letter.

    • Cannot end with a hyphen or contain two consecutive hyphens.

    • Must be unique for all clusters across Amazon RDS, Neptune, and Amazon DocumentDB per AWS account, per Region.

  • --source-region — If you are copying the snapshot to another AWS Region, specify the AWS Region that the encrypted cluster snapshot will be copied from.

    If you’re copying the snapshot to another AWS Region and you don’t specify --source-region, you must specify the pre-signed-url option instead. The pre-signed-url value must be a URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot action to be called in the source AWS Region where the cluster snapshot is copied from. To learn more about the pre-signed-url, see CopyDBClusterSnapshot.

  • --kms-key-id — The KMS key identifier for the key to use to encrypt the copy of the cluster snapshot.

    If you are copying an encrypted cluster snapshot to another AWS Region, this parameter is required. You must specify a KMS key for the destination AWS Region.

    If you are copying an encrypted cluster snapshot in the same AWS Region, the KMS key parameter is optional. The copy of the cluster snapshot is encrypted with the same KMS key as the source cluster snapshot. If you want to specify a new KMS encryption key to use to encrypt the copy, you can do so using this parameter.

  • --copy-tags — Optional. The tags and values to be copied over.

To cancel a copy operation once it’s in progress, you can delete the target cluster snapshot identified by --target-db-cluster-snapshot-identifier or TargetDBClusterSnapshotIdentifier while that cluster snapshot is in copying status.

Example 1: Copy an unencrypted snapshot to the same Region

The following AWS CLI example creates a copy of sample-cluster-snapshot named sample-cluster-snapshot-copy in the same AWS Region as the source snapshot. When the copy is made, all tags on the original snapshot are copied to the snapshot copy.

For Linux, macOS, or Unix:

  1. aws docdb copy-db-cluster-snapshot \
  2.     --source-db-cluster-snapshot-identifier sample-cluster-snapshot \
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
  4.     --copy-tags

For Windows:

  1. aws docdb copy-db-cluster-snapshot ^
  2.     --source-db-cluster-snapshot-identifier sample-cluster-snapshot ^
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy ^
  4.     --copy-tags

Output from this operation looks something like the following.

  1. {
  2.     "DBClusterSnapshot": {
  3.         "AvailabilityZones": [
  4.             "us-east-1a",
  5.             "us-east-1b",
  6.             "us-east-1c"
  7.         ],
  8.         "DBClusterSnapshotIdentifier": "sample-cluster-snapshot-copy",
  9.         "DBClusterIdentifier": "sample-cluster",
  10.         "SnapshotCreateTime": "2020-03-27T08:40:24.805Z",
  11.         "Engine": "docdb",
  12.         "Status": "copying",
  13.         "Port": 0,    
  14.         "VpcId": "vpc-abcd0123",
  15.         "ClusterCreateTime": "2020-01-10T22:13:38.261Z",
  16.         "MasterUsername": "master-user",
  17.         "EngineVersion": "4.0.0",
  18.         "SnapshotType": "manual",
  19.         "PercentProgress": 0,
  20.         "StorageEncrypted": true,
  21.         "KmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/sample-key-id",
  22.         "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:111122223333:cluster-snapshot:sample-cluster-snapshot-copy",
  23.         "SourceDBClusterSnapshotArn": "arn:aws:rds:us-east-1:111122223333:cluster-snapshot:sample-cluster-snapshot"
  24.     }
  25. }

Example 2: Copy an unencrypted snapshot across AWS Regions

The following AWS CLI example creates a copy of sample-cluster-snapshot, which has the ARN arn:aws:rds:us-east-1:123456789012:cluster-snapshot:sample-cluster-snapshot. This copy is named named sample-cluster-snapshot-copy and is in the AWS Region in which the command is run.

For Linux, macOS, or Unix:

  1. aws docdb copy-db-cluster-snapshot \
  2.     --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:sample-cluster-snapshot \
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy

For Windows:

  1. aws docdb copy-db-cluster-snapshot ^
  2.     --source-db-cluster-snapshot-identifier arn:aws:rds:us-east-1:123456789012:cluster-snapshot:sample-cluster-snapshot ^
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy

Output from this operation looks something like the following.

  1. {
  2.     "DBClusterSnapshot": {
  3.         "AvailabilityZones": [
  4.             "us-east-1a",
  5.             "us-east-1b",
  6.             "us-east-1c"
  7.         ],
  8.         "DBClusterSnapshotIdentifier": "sample-cluster-snapshot-copy",
  9.         "DBClusterIdentifier": "sample-cluster",
  10.         "SnapshotCreateTime": "2020-04-29T16:45:51.239Z",
  11.         "Engine": "docdb",
  12.         "AllocatedStorage": 0,
  13.         "Status": "copying",
  14.         "Port": 0,
  15.         "VpcId": "vpc-abc0123",
  16.         "ClusterCreateTime": "2020-04-28T16:43:00.294Z",
  17.         "MasterUsername": "master-user",
  18.         "EngineVersion": "4.0.0",
  19.         "LicenseModel": "docdb",
  20.         "SnapshotType": "manual",
  21.         "PercentProgress": 0,
  22.         "StorageEncrypted": false,
  23.         "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:111122223333:cluster-snapshot:sample-cluster-snapshot-copy",
  24.         "SourceDBClusterSnapshotArn": "arn:aws:rds:us-east-1:111122223333:cluster-snapshot:sample-cluster-snapshot",
  25.     }
  26. }

Example 3: Copy an encrypted snapshot across AWS Regions

The following AWS CLI example creates a copy of sample-cluster-snapshot from the us-west-2 Region to the us-east-1 Region. This command is called in the us-east-1 Region.

For Linux, macOS, or Unix:

  1. aws docdb copy-db-cluster-snapshot \
  2.     --source-db-cluster-snapshot-identifier arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot \
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy \
  4.     --source-region us-west-2 \
  5.     --kms-key-id sample-us-east-1-key

For Windows:

  1. aws docdb copy-db-cluster-snapshot ^
  2.     --source-db-cluster-snapshot-identifier arn:aws:rds:us-west-2:123456789012:cluster-snapshot:sample-cluster-snapshot ^
  3.     --target-db-cluster-snapshot-identifier sample-cluster-snapshot-copy ^
  4.     --source-region us-west-2 ^
  5.     --kms-key-id sample-us-east-1-key

Output from this operation looks something like the following.

  1. {
  2.     "DBClusterSnapshot": {  
  3.         "AvailabilityZones": [],
  4.         "DBClusterSnapshotIdentifier": "sample-cluster-snapshot-copy",
  5.         "DBClusterIdentifier": "ayhu-xrsc-test-ap-southeast-1-small-cluster-kms",
  6.         "SnapshotCreateTime": "2020-04-29T16:45:53.159Z",
  7.         "Engine": "docdb",
  8.         "AllocatedStorage": 0,
  9.         "Status": "copying",
  10.         "Port": 0,
  11.         "ClusterCreateTime": "2020-04-28T16:43:07.129Z",
  12.         "MasterUsername": "chimera",
  13.         "EngineVersion": "4.0.0",
  14.         "LicenseModel": "docdb",
  15.         "SnapshotType": "manual",
  16.         "PercentProgress": 0,
  17.         "StorageEncrypted": true,
  18.         "KmsKeyId": "arn:aws:kms:us-east-1:111122223333:key/sample-key-id",
  19.         "DBClusterSnapshotArn": "arn:aws:rds:us-east-1:111122223333:cluster-snapshot:sample-cluster-snapshot-copy",
  20.         "SourceDBClusterSnapshotArn": "arn:aws:rds:us-west-2:111122223333:cluster-snapshot:sample-cluster-snapshot",
  21.     }
  22. }