DocDBElastic / Client / create_cluster_snapshot

create_cluster_snapshot

DocDBElastic.Client.create_cluster_snapshot(**kwargs)

Creates a snapshot of a cluster.

See also: AWS API Documentation

Request Syntax

response = client.create_cluster_snapshot(
    clusterArn='string',
    snapshotName='string',
    tags={
        'string': 'string'
    }
)

Parameters:

• clusterArn (string) –

  [REQUIRED]

  The arn of the Elastic DocumentDB cluster that the snapshot will be taken from.

• snapshotName (string) –

  [REQUIRED]

  The name of the Elastic DocumentDB snapshot.

• tags (dict) –

  The tags to be assigned to the new Elastic DocumentDB snapshot.

  • (string) –

    • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • snapshot (dict) –

    Returns information about the new Elastic DocumentDB snapshot.

    • adminUserName (string) –

      The name of the Elastic DocumentDB cluster administrator.

    • clusterArn (string) –

      The arn of the Elastic DocumentDB cluster.

    • clusterCreationTime (string) –

      The time when the Elastic DocumentDB cluster was created in Universal Coordinated Time (UTC).

    • kmsKeyId (string) –

      The KMS key identifier to use to encrypt the Elastic DocumentDB cluster.

    • snapshotArn (string) –

      The arn of the Elastic DocumentDB snapshot

    • snapshotCreationTime (string) –

      The time when the Elastic DocumentDB snapshot was created in Universal Coordinated Time (UTC).

    • snapshotName (string) –

      The name of the Elastic DocumentDB snapshot.

    • status (string) –

      The status of the Elastic DocumentDB snapshot.

    • subnetIds (list) –

      A list of the IDs of subnets associated with the DB cluster snapshot.

      • (string) –

    • vpcSecurityGroupIds (list) –

      A list of the IDs of the VPC security groups associated with the cluster snapshot.

      • (string) –

Exceptions

• DocDBElastic.Client.exceptions.ThrottlingException

• DocDBElastic.Client.exceptions.ValidationException

• DocDBElastic.Client.exceptions.ServiceQuotaExceededException

• DocDBElastic.Client.exceptions.ConflictException

• DocDBElastic.Client.exceptions.InternalServerException

• DocDBElastic.Client.exceptions.ResourceNotFoundException

• DocDBElastic.Client.exceptions.AccessDeniedException