RDS / Client / create_db_cluster_snapshot

create_db_cluster_snapshot#

RDS.Client.create_db_cluster_snapshot(**kwargs)#

Creates a snapshot of a DB cluster.

For more information on Amazon Aurora, 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.

Request Syntax

response = client.create_db_cluster_snapshot(
    DBClusterSnapshotIdentifier='string',
    DBClusterIdentifier='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)

Parameters:

DBClusterSnapshotIdentifier (string) –
[REQUIRED]

The identifier of the DB cluster snapshot. This parameter is stored as a lowercase string.

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-cluster1-snapshot1
DBClusterIdentifier (string) –
[REQUIRED]

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

Constraints:
- Must match the identifier of an existing DBCluster.
Example: my-cluster1
Tags (list) –
The tags to be assigned to the DB cluster snapshot.
- (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}_.:/=+\-@]*)$”).

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'
    }
}

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) –
    
    Provides the list of Availability Zones (AZs) where instances in the DB cluster snapshot can be restored.
    - (string) –
  - DBClusterSnapshotIdentifier (string) –
    
    Specifies the identifier for the DB cluster snapshot.
  - DBClusterIdentifier (string) –
    
    Specifies the DB cluster identifier of the DB cluster that this DB cluster snapshot was created from.
  - SnapshotCreateTime (datetime) –
    
    Provides the time when the snapshot was taken, in Universal Coordinated Time (UTC).
  - Engine (string) –
    
    Specifies the name of the database engine for this DB cluster snapshot.
  - EngineMode (string) –
    
    Provides the engine mode of the database engine for this DB cluster snapshot.
  - AllocatedStorage (integer) –
    
    Specifies the allocated storage size in gibibytes (GiB).
  - Status (string) –
    
    Specifies the status of this DB cluster snapshot. Valid statuses are the following:
    - available
    - copying
    - creating
  - Port (integer) –
    
    Specifies the port that the DB cluster was listening on at the time of the snapshot.
  - VpcId (string) –
    
    Provides the VPC ID associated with the DB cluster snapshot.
  - ClusterCreateTime (datetime) –
    
    Specifies the time when the DB cluster was created, in Universal Coordinated Time (UTC).
  - MasterUsername (string) –
    
    Provides the master username for this DB cluster snapshot.
  - EngineVersion (string) –
    
    Provides the version of the database engine for this DB cluster snapshot.
  - LicenseModel (string) –
    
    Provides the license model information for this DB cluster snapshot.
  - SnapshotType (string) –
    
    Provides the type of the DB cluster snapshot.
  - PercentProgress (integer) –
    
    Specifies the percentage of the estimated data that has been transferred.
  - StorageEncrypted (boolean) –
    
    Specifies 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) –
    
    True if mapping of Amazon Web Services Identity and Access Management (IAM) accounts to database accounts is enabled, and otherwise false.
  - 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}_.:/=+\-@]*)$”).
  - 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.

Exceptions

RDS.Client.exceptions.DBClusterSnapshotAlreadyExistsFault
RDS.Client.exceptions.InvalidDBClusterStateFault
RDS.Client.exceptions.DBClusterNotFoundFault
RDS.Client.exceptions.SnapshotQuotaExceededFault
RDS.Client.exceptions.InvalidDBClusterSnapshotStateFault

Examples

This example creates a DB cluster snapshot.

response = client.create_db_cluster_snapshot(
    DBClusterIdentifier='mydbcluster',
    DBClusterSnapshotIdentifier='mydbclustersnapshot',
)

print(response)

Expected Output:

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