DocDBElastic / Client / restore_cluster_from_snapshot

restore_cluster_from_snapshot

DocDBElastic.Client.restore_cluster_from_snapshot(**kwargs)

Restores a Elastic DocumentDB cluster from a snapshot.

See also: AWS API Documentation

Request Syntax

response = client.restore_cluster_from_snapshot(
    clusterName='string',
    kmsKeyId='string',
    snapshotArn='string',
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    vpcSecurityGroupIds=[
        'string',
    ]
)

Parameters:

• clusterName (string) –

  [REQUIRED]

  The name of the Elastic DocumentDB cluster.

• kmsKeyId (string) –

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

  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, Elastic 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) –

  [REQUIRED]

  The arn of the Elastic DocumentDB snapshot.

• subnetIds (list) –

  The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

  • (string) –

• tags (dict) –

  A list of the tag names to be assigned to the restored DB cluster, in the form of an array of key-value pairs in which the key is the tag name and the value is the key value.

  • (string) –

    • (string) –

• vpcSecurityGroupIds (list) –

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

  • (string) –

Return type:

dict

Returns:

Response Syntax

{
    'cluster': {
        'adminUserName': 'string',
        'authType': 'PLAIN_TEXT'|'SECRET_ARN',
        'clusterArn': 'string',
        'clusterEndpoint': 'string',
        'clusterName': 'string',
        'createTime': 'string',
        'kmsKeyId': 'string',
        'preferredMaintenanceWindow': 'string',
        'shardCapacity': 123,
        'shardCount': 123,
        '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) –

  • cluster (dict) –

    Returns information about a the restored Elastic DocumentDB cluster.

    • adminUserName (string) –

      The name of the Elastic DocumentDB cluster administrator.

    • authType (string) –

      The authentication type for the Elastic DocumentDB cluster.

    • clusterArn (string) –

      The arn of the Elastic DocumentDB cluster.

    • clusterEndpoint (string) –

      The URL used to connect to the Elastic DocumentDB cluster.

    • clusterName (string) –

      The name of the Elastic DocumentDB cluster.

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

    • preferredMaintenanceWindow (string) –

      The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).

      Format: ddd:hh24:mi-ddd:hh24:mi

    • shardCapacity (integer) –

      The capacity of each shard in the Elastic DocumentDB cluster.

    • shardCount (integer) –

      The number of shards in the Elastic DocumentDB cluster.

    • status (string) –

      The status of the Elastic DocumentDB cluster.

    • subnetIds (list) –

      The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

      • (string) –

    • vpcSecurityGroupIds (list) –

      A list of EC2 VPC security groups associated with this cluster.

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