AWS API Changes

2022/11/30 - Amazon DocumentDB Elastic Clusters - 13 new api methods

Changes Launched Amazon DocumentDB Elastic Clusters. You can now use the SDK to create, list, update and delete Amazon DocumentDB Elastic Cluster resources

DeleteClusterSnapshot (new)

Link ¶

Delete a Elastic DocumentDB snapshot.

See also: AWS API Documentation

Request Syntax

client.delete_cluster_snapshot(
    snapshotArn='string'
)

type snapshotArn:

string

param snapshotArn:

[REQUIRED]

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

rtype:

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 newly deleted 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) --

ListClusterSnapshots (new)

Link ¶

Returns information about Elastic DocumentDB snapshots for a specified cluster.

See also: AWS API Documentation

Request Syntax

client.list_cluster_snapshots(
    clusterArn='string',
    maxResults=123,
    nextToken='string'
)

type clusterArn:

string

param clusterArn:

The arn of the Elastic DocumentDB cluster.

type maxResults:

integer

param maxResults:

The maximum number of entries to recieve in the response.

type nextToken:

string

param nextToken:

The nextToken which is used the get the next page of data.

rtype:

dict

returns:

Response Syntax

{
    'nextToken': 'string',
    'snapshots': [
        {
            'clusterArn': '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'
        },
    ]
}

Response Structure

(dict) --
- nextToken (string) --
  
  The response will provide a nextToken if there is more data beyond the maxResults.
  
  If there is no more data in the responce, the nextToken will not be returned.
- snapshots (list) --
  
  A list of Elastic DocumentDB snapshots for a specified cluster.
  - (dict) --
    
    A list of Elastic DocumentDB snapshots.
    - clusterArn (string) --
      
      The arn of 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.

UpdateCluster (new)

Link ¶

Modifies a Elastic DocumentDB cluster. This includes updating admin-username/password, upgrading API version setting up a backup window and maintenance window

See also: AWS API Documentation

Request Syntax

client.update_cluster(
    adminUserPassword='string',
    authType='PLAIN_TEXT'|'SECRET_ARN',
    clientToken='string',
    clusterArn='string',
    preferredMaintenanceWindow='string',
    shardCapacity=123,
    shardCount=123,
    subnetIds=[
        'string',
    ],
    vpcSecurityGroupIds=[
        'string',
    ]
)

type adminUserPassword:

string

param adminUserPassword:

The password for the Elastic DocumentDB cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).

Constraints: Must contain from 8 to 100 characters.

type authType:

string

param authType:

The authentication type for the Elastic DocumentDB cluster.

type clientToken:

string

param clientToken:

The client token for the Elastic DocumentDB cluster.

This field is autopopulated if not provided.

type clusterArn:

string

param clusterArn:

[REQUIRED]

The arn of the Elastic DocumentDB cluster.

type preferredMaintenanceWindow:

string

param preferredMaintenanceWindow:

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

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

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

type shardCapacity:

integer

param shardCapacity:

The capacity of each shard in the Elastic DocumentDB cluster.

type shardCount:

integer

param shardCount:

The number of shards to create in the Elastic DocumentDB cluster.

type subnetIds:

list

param subnetIds:

The number of shards to create in the Elastic DocumentDB cluster.

(string) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

(string) --

rtype:

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 updated 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) --

DeleteCluster (new)

Link ¶

Delete a Elastic DocumentDB cluster.

See also: AWS API Documentation

Request Syntax

client.delete_cluster(
    clusterArn='string'
)

type clusterArn:

string

param clusterArn:

[REQUIRED]

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

rtype:

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) --

TagResource (new)

Link ¶

Adds metadata tags to a Elastic DocumentDB resource

See also: AWS API Documentation

Request Syntax

client.tag_resource(
    resourceArn='string',
    tags={
        'string': 'string'
    }
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The arn of the Elastic DocumentDB resource.

type tags:

dict

param tags:

[REQUIRED]

The tags to be assigned to the Elastic DocumentDB resource.

(string) --
- (string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

RestoreClusterFromSnapshot (new)

Link ¶

Restores a Elastic DocumentDB cluster from a snapshot.

See also: AWS API Documentation

Request Syntax

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

type clusterName:

string

param clusterName:

[REQUIRED]

The name of the Elastic DocumentDB cluster.

type kmsKeyId:

string

param kmsKeyId:

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.

type snapshotArn:

string

param snapshotArn:

[REQUIRED]

The arn of the Elastic DocumentDB snapshot.

type subnetIds:

list

param subnetIds:

The Amazon EC2 subnet IDs for the Elastic DocumentDB cluster.

(string) --

type tags:

dict

param tags:

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) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

(string) --

rtype:

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) --

UntagResource (new)

Link ¶

Removes metadata tags to a Elastic DocumentDB resource

See also: AWS API Documentation

Request Syntax

client.untag_resource(
    resourceArn='string',
    tagKeys=[
        'string',
    ]
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The arn of the Elastic DocumentDB resource.

type tagKeys:

list

param tagKeys:

[REQUIRED]

The tag keys to be removed from the Elastic DocumentDB resource.

(string) --

rtype:

dict

returns:

Response Syntax

{}

Response Structure

(dict) --

GetClusterSnapshot (new)

Link ¶

Returns information about a specific Elastic DocumentDB snapshot

See also: AWS API Documentation

Request Syntax

client.get_cluster_snapshot(
    snapshotArn='string'
)

type snapshotArn:

string

param snapshotArn:

[REQUIRED]

The arn of the Elastic DocumentDB snapshot.

rtype:

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 a specific 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) --

ListClusters (new)

Link ¶

Returns information about provisioned Elastic DocumentDB clusters.

See also: AWS API Documentation

Request Syntax

client.list_clusters(
    maxResults=123,
    nextToken='string'
)

type maxResults:

integer

param maxResults:

The maximum number of entries to recieve in the response.

type nextToken:

string

param nextToken:

The nextToken which is used the get the next page of data.

rtype:

dict

returns:

Response Syntax

{
    'clusters': [
        {
            'clusterArn': 'string',
            'clusterName': 'string',
            'status': 'CREATING'|'ACTIVE'|'DELETING'|'UPDATING'|'VPC_ENDPOINT_LIMIT_EXCEEDED'|'IP_ADDRESS_LIMIT_EXCEEDED'|'INVALID_SECURITY_GROUP_ID'|'INVALID_SUBNET_ID'|'INACCESSIBLE_ENCRYPTION_CREDS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

(dict) --
- clusters (list) --
  
  A list of Elastic DocumentDB cluster.
  - (dict) --
    
    A list of Elastic DocumentDB cluster.
    - clusterArn (string) --
      
      The arn of the Elastic DocumentDB cluster.
    - clusterName (string) --
      
      The name of the Elastic DocumentDB cluster.
    - status (string) --
      
      The status of the Elastic DocumentDB cluster.
- nextToken (string) --
  
  The response will provide a nextToken if there is more data beyond the maxResults.
  
  If there is no more data in the responce, the nextToken will not be returned.

ListTagsForResource (new)

Link ¶

Lists all tags on a Elastic DocumentDB resource

See also: AWS API Documentation

Request Syntax

client.list_tags_for_resource(
    resourceArn='string'
)

type resourceArn:

string

param resourceArn:

[REQUIRED]

The arn of the Elastic DocumentDB resource.

rtype:

dict

returns:

Response Syntax

{
    'tags': {
        'string': 'string'
    }
}

Response Structure

(dict) --
- tags (dict) --
  
  The list of tags for the specified Elastic DocumentDB resource.
  - (string) --
    - (string) --

CreateCluster (new)

Link ¶

Creates a new Elastic DocumentDB cluster and returns its Cluster structure.

See also: AWS API Documentation

Request Syntax

client.create_cluster(
    adminUserName='string',
    adminUserPassword='string',
    authType='PLAIN_TEXT'|'SECRET_ARN',
    clientToken='string',
    clusterName='string',
    kmsKeyId='string',
    preferredMaintenanceWindow='string',
    shardCapacity=123,
    shardCount=123,
    subnetIds=[
        'string',
    ],
    tags={
        'string': 'string'
    },
    vpcSecurityGroupIds=[
        'string',
    ]
)

type adminUserName:

string

param adminUserName:

[REQUIRED]

The name of the Elastic DocumentDB cluster administrator.

Constraints:

Must be from 1 to 63 letters or numbers.
The first character must be a letter.
Cannot be a reserved word.

type adminUserPassword:

string

param adminUserPassword:

[REQUIRED]

The password for the Elastic DocumentDB cluster administrator and can contain any printable ASCII characters.

Constraints:

Must contain from 8 to 100 characters.
Cannot contain a forward slash (/), double quote ("), or the "at" symbol (@).

type authType:

string

param authType:

[REQUIRED]

The authentication type for the Elastic DocumentDB cluster.

type clientToken:

string

param clientToken:

The client token for the Elastic DocumentDB cluster.

This field is autopopulated if not provided.

type clusterName:

string

param clusterName:

[REQUIRED]

The name of the new Elastic DocumentDB cluster. This parameter is stored as a lowercase string.

Constraints:

Must contain from 1 to 63 letters, numbers, or hyphens.
The first character must be a letter.
Cannot end with a hyphen or contain two consecutive hyphens.

Example: my-cluster

type kmsKeyId:

string

param kmsKeyId:

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

If an encryption key is not specified, 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.

type preferredMaintenanceWindow:

string

param preferredMaintenanceWindow:

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

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

Default: a 30-minute window selected at random from an 8-hour block of time for each Amazon Web Services Region, occurring on a random day of the week.

Valid days: Mon, Tue, Wed, Thu, Fri, Sat, Sun

Constraints: Minimum 30-minute window.

type shardCapacity:

integer

param shardCapacity:

[REQUIRED]

The capacity of each shard in the new Elastic DocumentDB cluster.

type shardCount:

integer

param shardCount:

[REQUIRED]

The number of shards to create in the new Elastic DocumentDB cluster.

type subnetIds:

list

param subnetIds:

The Amazon EC2 subnet IDs for the new Elastic DocumentDB cluster.

(string) --

type tags:

dict

param tags:

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

(string) --
- (string) --

type vpcSecurityGroupIds:

list

param vpcSecurityGroupIds:

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

(string) --

rtype:

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) --
  
  The new Elastic DocumentDB cluster that has been created.
  - 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) --

CreateClusterSnapshot (new)

Link ¶

Creates a snapshot of a cluster.

See also: AWS API Documentation

Request Syntax

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

type clusterArn:

string

param clusterArn:

[REQUIRED]

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

type snapshotName:

string

param snapshotName:

[REQUIRED]

The name of the Elastic DocumentDB snapshot.

type tags:

dict

param tags:

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

(string) --
- (string) --

rtype:

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) --

GetCluster (new)

Link ¶

Returns information about a specific Elastic DocumentDB cluster.

See also: AWS API Documentation

Request Syntax

client.get_cluster(
    clusterArn='string'
)

type clusterArn:

string

param clusterArn:

[REQUIRED]

The arn of the Elastic DocumentDB cluster.

rtype:

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 specific 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) --