Navigation Guide
You are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.

CopyDBClusterSnapshotCommand

Copies a snapshot of a DB cluster.

To copy a DB cluster snapshot from a shared manual DB cluster snapshot, SourceDBClusterSnapshotIdentifier must be the Amazon Resource Name (ARN) of the shared DB cluster snapshot.

You can copy an encrypted DB cluster snapshot from another Amazon Web Services Region. In that case, the Amazon Web Services Region where you call the CopyDBClusterSnapshot operation is the destination Amazon Web Services Region for the encrypted DB cluster snapshot to be copied to. To copy an encrypted DB cluster snapshot from another Amazon Web Services Region, you must provide the following values:

KmsKeyId - The Amazon Web Services Key Management System (Amazon Web Services KMS) key identifier for the key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region.
TargetDBClusterSnapshotIdentifier - The identifier for the new copy of the DB cluster snapshot in the destination Amazon Web Services Region.
SourceDBClusterSnapshotIdentifier - The DB cluster snapshot identifier for the encrypted DB cluster snapshot to be copied. This identifier must be in the ARN format for the source Amazon Web Services Region and is the same value as the SourceDBClusterSnapshotIdentifier in the presigned URL.

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

For more information on copying encrypted Amazon Aurora DB cluster snapshots from one Amazon Web Services Region to another, see Copying a Snapshot in the Amazon Aurora User Guide.

For more information on Amazon Aurora DB clusters, see What is Amazon Aurora? in the Amazon Aurora User Guide.

For more information on Multi-AZ DB clusters, see Multi-AZ DB cluster deployments in the Amazon RDS User Guide.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { RDSClient, CopyDBClusterSnapshotCommand } from "@aws-sdk/client-rds"; // ES Modules import
// const { RDSClient, CopyDBClusterSnapshotCommand } = require("@aws-sdk/client-rds"); // CommonJS import
const client = new RDSClient(config);
const input = { // CopyDBClusterSnapshotMessage
  SourceDBClusterSnapshotIdentifier: "STRING_VALUE", // required
  TargetDBClusterSnapshotIdentifier: "STRING_VALUE", // required
  KmsKeyId: "STRING_VALUE",
  PreSignedUrl: "STRING_VALUE",
  CopyTags: true || false,
  Tags: [ // TagList
    { // Tag
      Key: "STRING_VALUE",
      Value: "STRING_VALUE",
    },
  ],
};
const command = new CopyDBClusterSnapshotCommand(input);
const response = await client.send(command);
// { // CopyDBClusterSnapshotResult
//   DBClusterSnapshot: { // DBClusterSnapshot
//     AvailabilityZones: [ // AvailabilityZones
//       "STRING_VALUE",
//     ],
//     DBClusterSnapshotIdentifier: "STRING_VALUE",
//     DBClusterIdentifier: "STRING_VALUE",
//     SnapshotCreateTime: new Date("TIMESTAMP"),
//     Engine: "STRING_VALUE",
//     EngineMode: "STRING_VALUE",
//     AllocatedStorage: Number("int"),
//     Status: "STRING_VALUE",
//     Port: Number("int"),
//     VpcId: "STRING_VALUE",
//     ClusterCreateTime: new Date("TIMESTAMP"),
//     MasterUsername: "STRING_VALUE",
//     EngineVersion: "STRING_VALUE",
//     LicenseModel: "STRING_VALUE",
//     SnapshotType: "STRING_VALUE",
//     PercentProgress: Number("int"),
//     StorageEncrypted: true || false,
//     KmsKeyId: "STRING_VALUE",
//     DBClusterSnapshotArn: "STRING_VALUE",
//     SourceDBClusterSnapshotArn: "STRING_VALUE",
//     IAMDatabaseAuthenticationEnabled: true || false,
//     TagList: [ // TagList
//       { // Tag
//         Key: "STRING_VALUE",
//         Value: "STRING_VALUE",
//       },
//     ],
//     DBSystemId: "STRING_VALUE",
//     StorageType: "STRING_VALUE",
//     DbClusterResourceId: "STRING_VALUE",
//     StorageThroughput: Number("int"),
//   },
// };

Example Usage

Loading code editor