RDS / Client / copy_db_snapshot

copy_db_snapshot#

RDS.Client.copy_db_snapshot(**kwargs)#

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

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

This command doesn’t apply to RDS Custom.

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

See also: AWS API Documentation

Request Syntax

response = client.copy_db_snapshot(
    SourceDBSnapshotIdentifier='string',
    TargetDBSnapshotIdentifier='string',
    KmsKeyId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ],
    CopyTags=True|False,
    OptionGroupName='string',
    TargetCustomAvailabilityZone='string',
    CopyOptionGroup=True|False,
    SourceRegion='string'
)

Parameters:

SourceDBSnapshotIdentifier (string) –
[REQUIRED]

The identifier for the source DB snapshot.

If the source snapshot is in the same Amazon Web Services 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 Web Services 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 Web Services Region.

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
TargetDBSnapshotIdentifier (string) –
[REQUIRED]

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
KmsKeyId (string) –
The Amazon Web Services KMS key identifier for an encrypted DB snapshot. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.

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

If you copy an encrypted DB snapshot that is shared from another Amazon Web Services 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 Web Services Region, then you must specify an Amazon Web Services KMS key identifier for 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.
Tags (list) –
A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
  - 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}_.:/=+\-@]*)$”).
CopyTags (boolean) – A value that indicates whether to copy all tags from the source DB snapshot to the target DB snapshot. By default, tags aren’t copied.
PreSignedUrl (string) –
When you are copying a snapshot from one Amazon Web Services GovCloud (US) Region to another, the URL that contains a Signature Version 4 signed request for the CopyDBSnapshot API operation in the source Amazon Web Services Region that contains the source DB snapshot to copy.

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

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

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:
- DestinationRegion - The Amazon Web Services Region that the encrypted DB snapshot is copied to. This Amazon Web Services Region is the same one where the CopyDBSnapshot operation is called that contains this presigned URL. For example, if you copy an encrypted DB snapshot from the us-west-2 Amazon Web Services Region to the us-east-1 Amazon Web Services Region, then you call the CopyDBSnapshot operation in the us-east-1 Amazon Web Services Region and provide a presigned URL that contains a call to the CopyDBSnapshot operation in the us-west-2 Amazon Web Services Region. For this example, the DestinationRegion in the presigned URL must be set to the us-east-1 Amazon Web Services Region.
- KmsKeyId - The KMS key identifier for the KMS key to use to encrypt the copy of the DB snapshot in the destination Amazon Web Services Region. This is the same identifier for both the CopyDBSnapshot operation that is called in the destination Amazon Web Services Region, and the operation 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 Web Services Region. For example, if you are copying an encrypted DB snapshot from the us-west-2 Amazon Web Services 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 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
OptionGroupName (string) –
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 Web Services 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 Web Services Regions. For more information, see Option group considerations in the Amazon RDS User Guide.
TargetCustomAvailabilityZone (string) –
The external custom Availability Zone (CAZ) identifier for the target CAZ.

Example: rds-caz-aiqhTgQv.
CopyOptionGroup (boolean) – A value that indicates whether to copy the DB option group associated with the source DB snapshot to the target Amazon Web Services account and associate with the target DB snapshot. The associated option group can be copied only with cross-account snapshot copy calls.
SourceRegion (string) – The ID of the region that contains the snapshot to be copied.

Return type:

dict

Returns:

Response Syntax

{
    'DBSnapshot': {
        'DBSnapshotIdentifier': 'string',
        'DBInstanceIdentifier': 'string',
        'SnapshotCreateTime': datetime(2015, 1, 1),
        'Engine': 'string',
        'AllocatedStorage': 123,
        'Status': 'string',
        'Port': 123,
        'AvailabilityZone': 'string',
        'VpcId': 'string',
        'InstanceCreateTime': datetime(2015, 1, 1),
        'MasterUsername': 'string',
        'EngineVersion': 'string',
        'LicenseModel': 'string',
        'SnapshotType': 'string',
        'Iops': 123,
        'OptionGroupName': 'string',
        'PercentProgress': 123,
        'SourceRegion': 'string',
        'SourceDBSnapshotIdentifier': 'string',
        'StorageType': 'string',
        'TdeCredentialArn': 'string',
        'Encrypted': True|False,
        'KmsKeyId': 'string',
        'DBSnapshotArn': 'string',
        'Timezone': 'string',
        'IAMDatabaseAuthenticationEnabled': True|False,
        'ProcessorFeatures': [
            {
                'Name': 'string',
                'Value': 'string'
            },
        ],
        'DbiResourceId': 'string',
        'TagList': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'OriginalSnapshotCreateTime': datetime(2015, 1, 1),
        'SnapshotDatabaseTime': datetime(2015, 1, 1),
        'SnapshotTarget': 'string',
        'StorageThroughput': 123
    }
}

Response Structure

(dict) –
- DBSnapshot (dict) –
  
  Contains the details of an Amazon RDS DB snapshot.
  
  This data type is used as a response element in the DescribeDBSnapshots action.
  - DBSnapshotIdentifier (string) –
    
    Specifies the identifier for the DB snapshot.
  - DBInstanceIdentifier (string) –
    
    Specifies the DB instance identifier of the DB instance this DB snapshot was created from.
  - SnapshotCreateTime (datetime) –
    
    Specifies when the snapshot was taken in Coordinated Universal Time (UTC). Changes for the copy when the snapshot is copied.
  - Engine (string) –
    
    Specifies the name of the database engine.
  - AllocatedStorage (integer) –
    
    Specifies the allocated storage size in gibibytes (GiB).
  - Status (string) –
    
    Specifies the status of this DB snapshot.
  - Port (integer) –
    
    Specifies the port that the database engine was listening on at the time of the snapshot.
  - AvailabilityZone (string) –
    
    Specifies the name of the Availability Zone the DB instance was located in at the time of the DB snapshot.
  - VpcId (string) –
    
    Provides the VPC ID associated with the DB snapshot.
  - InstanceCreateTime (datetime) –
    
    Specifies the time in Coordinated Universal Time (UTC) when the DB instance, from which the snapshot was taken, was created.
  - MasterUsername (string) –
    
    Provides the master username for the DB snapshot.
  - EngineVersion (string) –
    
    Specifies the version of the database engine.
  - LicenseModel (string) –
    
    License model information for the restored DB instance.
  - SnapshotType (string) –
    
    Provides the type of the DB snapshot.
  - Iops (integer) –
    
    Specifies the Provisioned IOPS (I/O operations per second) value of the DB instance at the time of the snapshot.
  - OptionGroupName (string) –
    
    Provides the option group name for the DB snapshot.
  - PercentProgress (integer) –
    
    The percentage of the estimated data that has been transferred.
  - SourceRegion (string) –
    
    The Amazon Web Services Region that the DB snapshot was created in or copied from.
  - SourceDBSnapshotIdentifier (string) –
    
    The DB snapshot Amazon Resource Name (ARN) that the DB snapshot was copied from. It only has a value in the case of a cross-account or cross-Region copy.
  - StorageType (string) –
    
    Specifies the storage type associated with DB snapshot.
  - TdeCredentialArn (string) –
    
    The ARN from the key store with which to associate the instance for TDE encryption.
  - Encrypted (boolean) –
    
    Specifies whether the DB snapshot is encrypted.
  - KmsKeyId (string) –
    
    If Encrypted is true, the Amazon Web Services KMS key identifier for the encrypted DB snapshot.
    
    The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key.
  - DBSnapshotArn (string) –
    
    The Amazon Resource Name (ARN) for the DB snapshot.
  - Timezone (string) –
    
    The time zone of the DB snapshot. In most cases, the Timezone element is empty. Timezone content appears only for snapshots taken from Microsoft SQL Server DB instances that were created with a time zone specified.
  - IAMDatabaseAuthenticationEnabled (boolean) –
    
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - ProcessorFeatures (list) –
    
    The number of CPU cores and the number of threads per core for the DB instance class of the DB instance when the DB snapshot was created.
    - (dict) –
      
      Contains the processor features of a DB instance class.
      
      To specify the number of CPU cores, use the coreCount feature name for the Name parameter. To specify the number of threads per core, use the threadsPerCore feature name for the Name parameter.
      
      You can set the processor features of the DB instance class for a DB instance when you call one of the following actions:
      - CreateDBInstance
      - ModifyDBInstance
      - RestoreDBInstanceFromDBSnapshot
      - RestoreDBInstanceFromS3
      - RestoreDBInstanceToPointInTime
      You can view the valid processor values for a particular instance class by calling the DescribeOrderableDBInstanceOptions action and specifying the instance class for the DBInstanceClass parameter.
      
      In addition, you can use the following actions for DB instance class processor information:
      - DescribeDBInstances
      - DescribeDBSnapshots
      - DescribeValidDBInstanceModifications
      If you call DescribeDBInstances, ProcessorFeature returns non-null values only if the following conditions are met:
      - You are accessing an Oracle DB instance.
      - Your Oracle DB instance class supports configuring the number of CPU cores and threads per core.
      - The current number CPU cores and threads is set to a non-default value.
      For more information, see Configuring the Processor of the DB Instance Class in the Amazon RDS User Guide.
      - Name (string) –
        
        The name of the processor feature. Valid names are coreCount and threadsPerCore.
      - Value (string) –
        
        The value of a processor feature name.
  - DbiResourceId (string) –
    
    The identifier for the source DB instance, which can’t be changed and which is unique to an Amazon Web Services Region.
  - TagList (list) –
    
    A list of tags. For more information, see Tagging Amazon RDS Resources in the Amazon RDS 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.
      - 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}_.:/=+\-@]*)$”).
  - OriginalSnapshotCreateTime (datetime) –
    
    Specifies the time of the CreateDBSnapshot operation in Coordinated Universal Time (UTC). Doesn’t change when the snapshot is copied.
  - SnapshotDatabaseTime (datetime) –
    
    The timestamp of the most recent transaction applied to the database that you’re backing up. Thus, if you restore a snapshot, SnapshotDatabaseTime is the most recent transaction in the restored DB instance. In contrast, originalSnapshotCreateTime specifies the system time that the snapshot completed.
    
    If you back up a read replica, you can determine the replica lag by comparing SnapshotDatabaseTime with originalSnapshotCreateTime. For example, if originalSnapshotCreateTime is two hours later than SnapshotDatabaseTime, then the replica lag is two hours.
  - SnapshotTarget (string) –
    
    Specifies where manual snapshots are stored: Amazon Web Services Outposts or the Amazon Web Services Region.
  - StorageThroughput (integer) –
    
    Specifies the storage throughput for the DB snapshot.

Exceptions

RDS.Client.exceptions.DBSnapshotAlreadyExistsFault
RDS.Client.exceptions.DBSnapshotNotFoundFault
RDS.Client.exceptions.InvalidDBSnapshotStateFault
RDS.Client.exceptions.SnapshotQuotaExceededFault
RDS.Client.exceptions.KMSKeyNotAccessibleFault
RDS.Client.exceptions.CustomAvailabilityZoneNotFoundFault

Examples

This example copies a DB snapshot.

response = client.copy_db_snapshot(
    SourceDBSnapshotIdentifier='mydbsnapshot',
    TargetDBSnapshotIdentifier='mydbsnapshot-copy',
)

print(response)

Expected Output:

{
    'DBSnapshot': {
    },
    'ResponseMetadata': {
        '...': '...',
    },
}