DocDBElastic / Client / create_cluster_snapshot

create_cluster_snapshot#

DocDBElastic.Client.create_cluster_snapshot(**kwargs)#

Creates a snapshot of an elastic 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 identifier of the elastic cluster of which you want to create a snapshot.

  • snapshotName (string) –

    [REQUIRED]

    The name of the new elastic cluster snapshot.

  • tags (dict) –

    The tags to be assigned to the new elastic cluster snapshot.

    • (string) –

      • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'snapshot': {
        'adminUserName': 'string',
        'clusterArn': 'string',
        'clusterCreationTime': 'string',
        'kmsKeyId': 'string',
        'snapshotArn': 'string',
        'snapshotCreationTime': 'string',
        'snapshotName': 'string',
        'snapshotType': 'MANUAL'|'AUTOMATED',
        'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'|'INACCESSIBLE_SECRET_ARN'|'INACCESSIBLE_VPC_ENDPOINT'|'INCOMPATIBLE_NETWORK'|'MERGING'|'MODIFYING'|'SPLITTING'|'COPYING'|'STARTING'|'STOPPING'|'STOPPED',
        'subnetIds': [
            'string',
        ],
        'vpcSecurityGroupIds': [
            'string',
        ]
    }
}

Response Structure

  • (dict) –

    • snapshot (dict) –

      Returns information about the new elastic cluster snapshot.

      • adminUserName (string) –

        The name of the elastic cluster administrator.

      • clusterArn (string) –

        The ARN identifier of the elastic cluster.

      • clusterCreationTime (string) –

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

      • kmsKeyId (string) –

        The KMS key identifier is the Amazon Resource Name (ARN) for the KMS encryption key. If you are creating a cluster using the same Amazon account that owns this KMS encryption key, you can use the KMS key alias instead of the ARN as the KMS encryption key. If an encryption key is not specified here, Amazon DocumentDB uses the default encryption key that KMS creates for your account. Your account has a different default encryption key for each Amazon Region.

      • snapshotArn (string) –

        The ARN identifier of the elastic cluster snapshot.

      • snapshotCreationTime (string) –

        The time when the elastic cluster snapshot was created in Universal Coordinated Time (UTC).

      • snapshotName (string) –

        The name of the elastic cluster snapshot.

      • snapshotType (string) –

        The type of cluster snapshots to be returned. You can specify one of the following values:

        • automated - Return all cluster snapshots that Amazon DocumentDB has automatically created for your Amazon Web Services account.

        • manual - Return all cluster snapshots that you have manually created for your Amazon Web Services account.

      • status (string) –

        The status of the elastic cluster snapshot.

      • subnetIds (list) –

        The Amazon EC2 subnet IDs for the elastic cluster.

        • (string) –

      • vpcSecurityGroupIds (list) –

        A list of EC2 VPC security groups to associate with the elastic cluster.

        • (string) –

Exceptions