CfnClusterProps

class aws_cdk.aws_docdbelastic.CfnClusterProps(*, admin_user_name, auth_type, cluster_name, shard_capacity, shard_count, admin_user_password=None, backup_retention_period=None, kms_key_id=None, preferred_backup_window=None, preferred_maintenance_window=None, shard_instance_count=None, subnet_ids=None, tags=None, vpc_security_group_ids=None)

Bases: object

Properties for defining a CfnCluster.

Parameters:

  • admin_user_name (str) – The name of the Amazon DocumentDB elastic clusters administrator. Constraints : - Must be from 1 to 63 letters or numbers. - The first character must be a letter. - Cannot be a reserved word.

  • auth_type (str) – The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are PLAIN_TEXT or SECRET_ARN .

  • cluster_name (str) – The name of the new elastic 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

  • shard_capacity (Union[int, float]) – The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

  • shard_count (Union[int, float]) – The number of shards assigned to the elastic cluster. Maximum is 32.

  • admin_user_password (Optional[str]) – 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 (@). - A valid AdminUserName entry is also required.

  • backup_retention_period (Union[int, float, None]) – The number of days for which automatic snapshots are retained.

  • kms_key_id (Optional[str]) – The KMS key identifier to use to encrypt the new elastic 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, 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.

  • preferred_backup_window (Optional[str]) – The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

  • preferred_maintenance_window (Optional[str]) – 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 AWS Region , occurring on a random day of the week. Valid days : Mon, Tue, Wed, Thu, Fri, Sat, Sun Constraints : Minimum 30-minute window.

  • shard_instance_count (Union[int, float, None]) – The number of replica instances applying to all shards in the cluster. A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

  • subnet_ids (Optional[Sequence[str]]) – The Amazon EC2 subnet IDs for the new elastic cluster.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags to be assigned to the new elastic cluster.

  • vpc_security_group_ids (Optional[Sequence[str]]) – A list of EC2 VPC security groups to associate with the new elastic cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_docdbelastic as docdbelastic

cfn_cluster_props = docdbelastic.CfnClusterProps(
    admin_user_name="adminUserName",
    auth_type="authType",
    cluster_name="clusterName",
    shard_capacity=123,
    shard_count=123,

    # the properties below are optional
    admin_user_password="adminUserPassword",
    backup_retention_period=123,
    kms_key_id="kmsKeyId",
    preferred_backup_window="preferredBackupWindow",
    preferred_maintenance_window="preferredMaintenanceWindow",
    shard_instance_count=123,
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    vpc_security_group_ids=["vpcSecurityGroupIds"]
)

Attributes

admin_user_name

The name of the Amazon DocumentDB elastic clusters administrator.

Constraints :

  • Must be from 1 to 63 letters or numbers.

  • The first character must be a letter.

  • Cannot be a reserved word.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminusername

admin_user_password

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

  • A valid AdminUserName entry is also required.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-adminuserpassword

auth_type

The authentication type used to determine where to fetch the password used for accessing the elastic cluster.

Valid types are PLAIN_TEXT or SECRET_ARN .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-authtype

backup_retention_period

The number of days for which automatic snapshots are retained.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-backupretentionperiod

cluster_name

The name of the new elastic 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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-clustername

kms_key_id

The KMS key identifier to use to encrypt the new elastic 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, 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.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-kmskeyid

preferred_backup_window

The daily time range during which automated backups are created if automated backups are enabled, as determined by backupRetentionPeriod .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredbackupwindow

preferred_maintenance_window

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 AWS Region , occurring on a random day of the week.

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

Constraints : Minimum 30-minute window.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-preferredmaintenancewindow

shard_capacity

The number of vCPUs assigned to each elastic cluster shard.

Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcapacity

shard_count

The number of shards assigned to the elastic cluster.

Maximum is 32.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardcount

shard_instance_count

The number of replica instances applying to all shards in the cluster.

A shardInstanceCount value of 1 means there is one writer instance, and any additional instances are replicas that can be used for reads and to improve availability.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-shardinstancecount

subnet_ids

The Amazon EC2 subnet IDs for the new elastic cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-subnetids

tags

The tags to be assigned to the new elastic cluster.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-tags

vpc_security_group_ids

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

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-docdbelastic-cluster.html#cfn-docdbelastic-cluster-vpcsecuritygroupids