RDS / Client / copy_db_cluster_snapshot

copy_db_cluster_snapshot

RDS.Client.copy_db_cluster_snapshot(**kwargs)

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.

See also: AWS API Documentation

Request Syntax

response = client.copy_db_cluster_snapshot(
    SourceDBClusterSnapshotIdentifier='string',
    TargetDBClusterSnapshotIdentifier='string',
    KmsKeyId='string',
    CopyTags=True|False,
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    SourceRegion='string'
)

Parameters:

• SourceDBClusterSnapshotIdentifier (string) –

  [REQUIRED]

  The identifier of the DB cluster snapshot to copy. This parameter isn’t case-sensitive.

  You can’t copy an encrypted, shared DB cluster snapshot from one Amazon Web Services Region to another.

  Constraints:

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

  • If the source snapshot is in the same Amazon Web Services Region as the copy, specify a valid DB snapshot identifier.

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid DB cluster snapshot ARN. For more information, go to Copying Snapshots Across Amazon Web Services Regions in the Amazon Aurora User Guide.

  Example: my-cluster-snapshot1

• TargetDBClusterSnapshotIdentifier (string) –

  [REQUIRED]

  The identifier of the new DB cluster snapshot to create from the source DB cluster snapshot. This parameter isn’t case-sensitive.

  Constraints:

  • Must contain from 1 to 63 letters, numbers, or hyphens.

  • First character must be a letter.

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

  Example: my-cluster-snapshot2

• KmsKeyId (string) –

  The Amazon Web Services KMS key identifier for an encrypted DB cluster snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the Amazon Web Services KMS key.

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

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

  To copy an encrypted DB cluster snapshot to another Amazon Web Services Region, you must set KmsKeyId to the Amazon Web Services KMS key identifier you want to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. KMS keys are specific to the Amazon Web Services Region that they are created in, and you can’t use KMS keys from one Amazon Web Services Region in another Amazon Web Services Region.

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

• PreSignedUrl (string) –

  When you are copying a DB cluster snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBClusterSnapshot API operation in the Amazon Web Services Region that contains the source DB cluster snapshot to copy. Use the PreSignedUrl parameter when copying an encrypted DB cluster snapshot from another Amazon Web Services Region. Don’t specify PreSignedUrl when copying an encrypted DB cluster snapshot in the same Amazon Web Services Region.

  This setting applies only to Amazon Web Services GovCloud (US) Regions. It’s ignored in other Amazon Web Services Regions.

  The presigned URL must be a valid request for the CopyDBClusterSnapshot API operation that can run in the source Amazon Web Services Region that contains the encrypted DB cluster snapshot to copy. The presigned URL request must contain the following parameter values:

  • KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB cluster snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBClusterSnapshot operation that is called in the destination Amazon Web Services Region, and the operation contained in the presigned URL.

  • DestinationRegion - The name of the Amazon Web Services Region that the DB cluster snapshot is to be created in.

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

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

  Note

  If you are using an Amazon Web Services SDK tool or the CLI, you can specify SourceRegion (or --source-region for the CLI) instead of specifying PreSignedUrl manually. Specifying SourceRegion autogenerates a presigned URL that is a valid request for the operation that can run in the source Amazon Web Services Region.

  Please note that this parameter is automatically populated if it is not provided. Including this parameter is not required

• CopyTags (boolean) – Specifies whether to copy all tags from the source DB cluster snapshot to the target DB cluster snapshot. By default, tags are not copied.

• Tags (list) –

  A list of tags.

  For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

  • (dict) –

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

    For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

    • Key (string) –

      A key is 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 only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

    • Value (string) –

      A value is 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 only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

• SourceRegion (string) – The ID of the region that contains the snapshot to be copied.

Return type:

dict

Returns:

Response Syntax

{
    'DBClusterSnapshot': {
        'AvailabilityZones': [
            'string',
        ],
        'DBClusterSnapshotIdentifier': 'string',
        'DBClusterIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'EngineMode': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'DBSystemId': 'string',
        'StorageType': 'string',
        'DbClusterResourceId': 'string',
        'StorageThroughput': 123
    }
}

Response Structure

• (dict) –

  • DBClusterSnapshot (dict) –

    Contains the details for an Amazon RDS DB cluster snapshot

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

    • AvailabilityZones (list) –

      The list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.

      • (string) –

    • DBClusterSnapshotIdentifier (string) –

      The identifier for the DB cluster snapshot.

    • DBClusterIdentifier (string) –

      The DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.

    • SnapshotCreateTime (datetime) –

      The time when the snapshot was taken, in Universal Coordinated Time (UTC).

    • Engine (string) –

      The name of the database engine for this DB cluster snapshot.

    • EngineMode (string) –

      The engine mode of the database engine for this DB cluster snapshot.

    • AllocatedStorage (integer) –

      The allocated storage size of the DB cluster snapshot in gibibytes (GiB).

    • Status (string) –

      The status of this DB cluster snapshot. Valid statuses are the following:

      • available

      • copying

      • creating

    • Port (integer) –

      The port that the DB cluster was listening on at the time of the snapshot.

    • VpcId (string) –

      The VPC ID associated with the DB cluster snapshot.

    • ClusterCreateTime (datetime) –

      The time when the DB cluster was created, in Universal Coordinated Time (UTC).

    • MasterUsername (string) –

      The master username for this DB cluster snapshot.

    • EngineVersion (string) –

      The version of the database engine for this DB cluster snapshot.

    • LicenseModel (string) –

      The license model information for this DB cluster snapshot.

    • SnapshotType (string) –

      The type of the DB cluster snapshot.

    • PercentProgress (integer) –

      The percentage of the estimated data that has been transferred.

    • StorageEncrypted (boolean) –

      Indicates whether the DB cluster snapshot is encrypted.

    • KmsKeyId (string) –

      If StorageEncrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB cluster snapshot.

      The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

    • DBClusterSnapshotArn (string) –

      The Amazon Resource Name (ARN) for the DB cluster snapshot.

    • SourceDBClusterSnapshotArn (string) –

      If the DB cluster snapshot was copied from a source DB cluster snapshot, the Amazon Resource Name (ARN) for the source DB cluster snapshot, otherwise, a null value.

    • IAMDatabaseAuthenticationEnabled (boolean) –

      Indicates whether mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled.

    • TagList (list) –

      A list of tags.

      For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

      • (dict) –

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

        For more information, see Tagging Amazon RDS resources in the Amazon RDS User Guide or Tagging Amazon Aurora and Amazon RDS resources in the Amazon Aurora User Guide.

        • Key (string) –

          A key is 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 only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

        • Value (string) –

          A value is 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 only contain only the set of Unicode letters, digits, white-space, ‘_’, ‘.’, ‘:’, ‘/’, ‘=’, ‘+’, ‘-’, ‘@’ (Java regex: “^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$”).

    • DBSystemId (string) –

      Reserved for future use.

    • StorageType (string) –

      The storage type associated with the DB cluster snapshot.

      This setting is only for Aurora DB clusters.

    • DbClusterResourceId (string) –

      The resource ID of the DB cluster that this DB cluster snapshot was created from.

    • StorageThroughput (integer) –

      The storage throughput for the DB cluster snapshot. The throughput is automatically set based on the IOPS that you provision, and is not configurable.

      This setting is only for non-Aurora Multi-AZ DB clusters.

Exceptions

• RDS.Client.exceptions.DBClusterSnapshotAlreadyExistsFault

• RDS.Client.exceptions.DBClusterSnapshotNotFoundFault

• RDS.Client.exceptions.InvalidDBClusterStateFault

• RDS.Client.exceptions.InvalidDBClusterSnapshotStateFault

• RDS.Client.exceptions.SnapshotQuotaExceededFault

• RDS.Client.exceptions.KMSKeyNotAccessibleFault

Examples

The following example copies an automated snapshot of a DB cluster to a new DB cluster snapshot.

response = client.copy_db_cluster_snapshot(
    SourceDBClusterSnapshotIdentifier='rds:sample-cluster-2016-09-14-10-38',
    TargetDBClusterSnapshotIdentifier='cluster-snapshot-copy-1',
)

print(response)

Expected Output:

{
    'DBClusterSnapshot': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}