DocDBElastic / Client / create_cluster

create_cluster#

DocDBElastic.Client.create_cluster(**kwargs)#

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

See also: AWS API Documentation

Request Syntax

response = 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',
    ]
)
Parameters:
  • adminUserName (string) –

    [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.

  • adminUserPassword (string) –

    [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 (@).

  • authType (string) –

    [REQUIRED]

    The authentication type for the Elastic DocumentDB cluster.

  • clientToken (string) –

    The client token for the Elastic DocumentDB cluster.

    This field is autopopulated if not provided.

  • clusterName (string) –

    [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

  • 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, 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.

  • preferredMaintenanceWindow (string) –

    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.

  • shardCapacity (integer) –

    [REQUIRED]

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

  • shardCount (integer) –

    [REQUIRED]

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

  • subnetIds (list) –

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

    • (string) –

  • tags (dict) –

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

    • (string) –

      • (string) –

  • vpcSecurityGroupIds (list) –

    A list of EC2 VPC security groups to associate with the new 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) –

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

Exceptions