Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

delete_cluster

DocDBElastic.Client.delete_cluster(**kwargs)

Delete a Elastic DocumentDB cluster.

See also: AWS API Documentation

Request Syntax

response = client.delete_cluster(
    clusterArn='string'
)
Parameters
clusterArn (string) --

[REQUIRED]

The arn of the Elastic DocumentDB cluster that is to be deleted.

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 the newly deleted 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.ConflictException
  • DocDBElastic.Client.exceptions.InternalServerException
  • DocDBElastic.Client.exceptions.ResourceNotFoundException
  • DocDBElastic.Client.exceptions.AccessDeniedException