DocDB / Client / copy_db_cluster_snapshot

copy_db_cluster_snapshot

DocDB.Client.copy_db_cluster_snapshot(**kwargs)

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 Amazon Web Services 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

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 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 Amazon Web Services Region as the copy, specify a valid snapshot identifier.

  • If the source snapshot is in a different Amazon Web Services Region than the copy, specify a valid cluster snapshot ARN.

  Example: my-cluster-snapshot1

• TargetDBClusterSnapshotIdentifier (string) –

  [REQUIRED]

  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

• KmsKeyId (string) –

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

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

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

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

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

• PreSignedUrl (string) –

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

  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 pre-signed URL that is a valid request for the operation that can be executed in the source Amazon Web Services Region.

  The presigned URL must be a valid request for the CopyDBClusterSnapshot API action that can be executed in the source Amazon Web Services 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 Amazon Web Services Region. For example, if you are copying an encrypted cluster snapshot from the us-east-1 Amazon Web Services 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.

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

• CopyTags (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.

  • (dict) –

    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}_.:/=+\-]*)$”).

• 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',
        'Status': 'string',
        'Port': 123,
        'VpcId': 'string',
        'ClusterCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'SnapshotType': 'string',
        'PercentProgress': 123,
        'StorageEncrypted': True|False,
        'KmsKeyId': 'string',
        'DBClusterSnapshotArn': 'string',
        'SourceDBClusterSnapshotArn': 'string',
        'StorageType': 'string'
    }
}

Response Structure

• (dict) –

  • DBClusterSnapshot (dict) –

    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 (datetime) –

      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 (datetime) –

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

    • StorageType (string) –

      Storage type associated with your cluster snapshot

      For information on storage types for Amazon DocumentDB clusters, see Cluster storage configurations in the Amazon DocumentDB Developer Guide.

      Valid values for storage type - standard | iopt1

      Default value is standard

Exceptions

• DocDB.Client.exceptions.DBClusterSnapshotAlreadyExistsFault

• DocDB.Client.exceptions.DBClusterSnapshotNotFoundFault

• DocDB.Client.exceptions.InvalidDBClusterStateFault

• DocDB.Client.exceptions.InvalidDBClusterSnapshotStateFault

• DocDB.Client.exceptions.SnapshotQuotaExceededFault

• DocDB.Client.exceptions.KMSKeyNotAccessibleFault