CopyDBSnapshot - Amazon Relational Database Service
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

CopyDBSnapshot

Copies the specified DB snapshot. The source DB snapshot must be in the available state.

You can copy a snapshot from one Amazon Region to another. In that case, the Amazon Region where you call the CopyDBSnapshot action is the destination Amazon Region for the DB snapshot copy.

For more information about copying snapshots, see Copying a DB Snapshot in the Amazon RDS User Guide.

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

CopyTags

A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags are not copied.

Type: Boolean

Required: No

KmsKeyId

The Amazon KMS key identifier for an encrypted DB snapshot. The Amazon KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon KMS customer master key (CMK).

If you copy an encrypted DB snapshot from your Amazon account, you can specify a value for this parameter to encrypt the copy with a new Amazon KMS CMK. If you don't specify a value for this parameter, then the copy of the DB snapshot is encrypted with the same Amazon KMS key as the source DB snapshot.

If you copy an encrypted DB snapshot that is shared from another Amazon account, then you must specify a value for this parameter.

If you specify this parameter when you copy an unencrypted snapshot, the copy is encrypted.

If you copy an encrypted snapshot to a different Amazon Region, then you must specify a Amazon KMS key identifier for the destination Amazon Region. Amazon KMS CMKs are specific to the Amazon Region that they are created in, and you can't use CMKs from one Amazon Region in another Amazon Region.

Type: String

Required: No

OptionGroupName

The name of an option group to associate with the copy of the snapshot.

Specify this option if you are copying a snapshot from one Amazon Region to another, and your DB instance uses a nondefault option group. If your source DB instance uses Transparent Data Encryption for Oracle or Microsoft SQL Server, you must specify this option when copying across Amazon Regions. For more information, see Option group considerations in the Amazon RDS User Guide.

Type: String

Required: No

PreSignedUrl

The URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API action in the source Amazon Region that contains the source DB snapshot to copy.

You must specify this parameter when you copy an encrypted DB snapshot from another Amazon Region by using the Amazon RDS API. Don't specify PreSignedUrl when you are copying an encrypted DB snapshot in the same Amazon Region.

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

  • DestinationRegion - The Amazon Region that the encrypted DB snapshot is copied to. This Amazon Region is the same one where the CopyDBSnapshot action is called that contains this presigned URL.

    For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Region to the us-east-1 Amazon Region, then you call the CopyDBSnapshot action in the us-east-1 Amazon Region and provide a presigned URL that contains a call to the CopyDBSnapshot action in the us-west-2 Amazon Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Region.

  • KmsKeyId - The Amazon KMS key identifier for the customer master key (CMK) to use to encrypt the copy of the DB snapshot in the destination Amazon Region. This is the same identifier for both the CopyDBSnapshot action that is called in the destination Amazon Region, and the action contained in the presigned URL.

  • SourceDBSnapshotIdentifier - The DB snapshot identifier for the encrypted snapshot to be copied. This identifier must be in the Amazon Resource Name (ARN) format for the source Amazon Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Region, then your SourceDBSnapshotIdentifier looks like the following example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20161115.

To learn how to generate a Signature Version 4 signed request, see Authenticating Requests: Using Query Parameters (Amazon Signature Version 4) and Signature Version 4 Signing Process.

Note

If you are using an Amazon SDK tool or the Amazon CLI, you can specify SourceRegion (or --source-region for the Amazon 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 Amazon Region.

Type: String

Required: No

SourceDBSnapshotIdentifier

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Region as the copy, specify a valid DB snapshot identifier. For example, you might specify rds:mysql-instance1-snapshot-20130805.

If the source snapshot is in a different Amazon Region than the copy, specify a valid DB snapshot ARN. For example, you might specify arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805.

If you are copying from a shared manual DB snapshot, this parameter must be the Amazon Resource Name (ARN) of the shared DB snapshot.

If you are copying an encrypted snapshot this parameter must be in the ARN format for the source Amazon Region, and must match the SourceDBSnapshotIdentifier in the PreSignedUrl parameter.

Constraints:

  • Must specify a valid system snapshot in the "available" state.

Example: rds:mydb-2012-04-02-00-01

Example: arn:aws:rds:us-west-2:123456789012:snapshot:mysql-instance1-snapshot-20130805

Type: String

Required: Yes

Tags.Tag.N

A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS User Guide.

Type: Array of Tag objects

Required: No

TargetCustomAvailabilityZone

The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.

Type: String

Required: No

TargetDBSnapshotIdentifier

The identifier for the copy of the snapshot.

Constraints:

  • Can't be null, empty, or blank

  • Must contain from 1 to 255 letters, numbers, or hyphens

  • First character must be a letter

  • Can't end with a hyphen or contain two consecutive hyphens

Example: my-db-snapshot

Type: String

Required: Yes

Response Elements

The following element is returned by the service.

DBSnapshot

Contains the details of an Amazon RDS DB snapshot.

This data type is used as a response element in the DescribeDBSnapshots action.

Type: DBSnapshot object

Errors

For information about the errors that are common to all actions, see Common Errors.

CustomAvailabilityZoneNotFound

CustomAvailabilityZoneId doesn't refer to an existing custom Availability Zone identifier.

HTTP Status Code: 404

DBSnapshotAlreadyExists

DBSnapshotIdentifier is already used by an existing snapshot.

HTTP Status Code: 400

DBSnapshotNotFound

DBSnapshotIdentifier doesn't refer to an existing DB snapshot.

HTTP Status Code: 404

InvalidDBSnapshotState

The state of the DB snapshot doesn't allow deletion.

HTTP Status Code: 400

KMSKeyNotAccessibleFault

An error occurred accessing an Amazon KMS key.

HTTP Status Code: 400

SnapshotQuotaExceeded

The request would result in the user exceeding the allowed number of DB snapshots.

HTTP Status Code: 400

Examples

Example

This example illustrates one usage of CopyDBSnapshot.

Sample Request

https://rds.us-east-1.amazonaws.com/ ?Action=CopyDBSnapshot &SignatureMethod=HmacSHA256 &SignatureVersion=4 &SourceDBSnapshotIdentifier=arn%3Aaws%3Ards%3Aus-east-1%3A815981987263%3Asnapshot%3Ards%3Amysqldb-2014-04-27-08-15 &TargetDBSnapshotIdentifier=mysqldb-arn &Version=2014-09-01 &X-Amz-Algorithm=AWS4-HMAC-SHA256 &X-Amz-Credential=AKIADQKE4SARGYLE/20140429/us-east-1/rds/aws4_request &X-Amz-Date=20140429T175351Z &X-Amz-SignedHeaders=content-type;host;user-agent;x-amz-content-sha256;x-amz-date &X-Amz-Signature=9164337efa99caf850e874a1cb7ef62f3cea29d0b448b9e0e7c53b288ddffed2

Sample Response

<CopyDBSnapshotResponse xmlns="http://rds.amazonaws.com/doc/2014-09-01/"> <CopyDBSnapshotResult> <DBSnapshot> <Port>3306</Port> <OptionGroupName>default:mysql-5-6</OptionGroupName> <Engine>mysql</Engine> <Status>available</Status> <SnapshotType>manual</SnapshotType> <LicenseModel>general-public-license</LicenseModel> <EngineVersion>5.6.13</EngineVersion> <DBInstanceIdentifier>mysqldb</DBInstanceIdentifier> <DBSnapshotIdentifier>mysqldb-arn</DBSnapshotIdentifier> <SnapshotCreateTime>2014-04-27T08:16:05.356Z</SnapshotCreateTime> <AvailabilityZone>us-east-1a</AvailabilityZone> <InstanceCreateTime>2014-04-21T22:24:26.573Z</InstanceCreateTime> <PercentProgress>100</PercentProgress> <AllocatedStorage>100</AllocatedStorage> <MasterUsername>awsmasteruser</MasterUsername> </DBSnapshot> </CopyDBSnapshotResult> <ResponseMetadata> <RequestId>2928d60e-beb6-11d3-8e5c-3ccda5460c46</RequestId> </ResponseMetadata> </CopyDBSnapshotResponse>