Skip to content

UpdateClusterInput

Source code in docs_src/capo_docdb_elastic/types/update_cluster_input.py
class UpdateClusterInput(TypedDict, closed=True):
    cluster_arn: "str"
    """<p>The ARN identifier of the elastic cluster.</p>"""
    auth_type: NotRequired["capo_docdb_elastic.types.auth.Auth"]
    """<p>The authentication type used to determine where to fetch the password used for accessing the elastic cluster. Valid types are <code>PLAIN_TEXT</code> or <code>SECRET_ARN</code>.</p>"""
    shard_capacity: NotRequired["int"]
    """<p>The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.</p>"""
    shard_count: NotRequired["int"]
    """<p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>"""
    vpc_security_group_ids: NotRequired[
        "capo_docdb_elastic.types.string_list.StringList"
    ]
    """<p>A list of EC2 VPC security groups to associate with the elastic cluster.</p>"""
    subnet_ids: NotRequired["capo_docdb_elastic.types.string_list.StringList"]
    """<p>The Amazon EC2 subnet IDs for the elastic cluster.</p>"""
    admin_user_password: NotRequired["capo_docdb_elastic.types.password.Password"]
    """<p>The password associated with the elastic cluster administrator. This password can contain any printable ASCII character except forward slash (/), double quote ("), or the "at" symbol (@).</p> <p> <i>Constraints</i>: Must contain from 8 to 100 characters.</p>"""
    client_token: NotRequired["str"]
    """<p>The client token for the elastic cluster.</p>"""
    preferred_maintenance_window: NotRequired["str"]
    """<p>The weekly time range during which system maintenance can occur, in Universal Coordinated Time (UTC).</p> <p> <i>Format</i>: <code>ddd:hh24:mi-ddd:hh24:mi</code> </p> <p> <i>Default</i>: 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.</p> <p> <i>Valid days</i>: Mon, Tue, Wed, Thu, Fri, Sat, Sun</p> <p> <i>Constraints</i>: Minimum 30-minute window.</p>"""
    backup_retention_period: NotRequired["int"]
    """<p>The number of days for which automatic snapshots are retained.</p>"""
    preferred_backup_window: NotRequired["str"]
    """<p>The daily time range during which automated backups are created if automated backups are enabled, as determined by the <code>backupRetentionPeriod</code>.</p>"""
    shard_instance_count: NotRequired["int"]
    """<p>The number of replica instances applying to all shards in the elastic cluster. A <code>shardInstanceCount</code> 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.</p>"""

admin_user_password instance-attribute

admin_user_password: NotRequired[Password]

The password associated with the elastic 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.

auth_type instance-attribute

auth_type: NotRequired[Auth]

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.

backup_retention_period instance-attribute

backup_retention_period: NotRequired[int]

The number of days for which automatic snapshots are retained.

client_token instance-attribute

client_token: NotRequired[str]

The client token for the elastic cluster.

cluster_arn instance-attribute

cluster_arn: str

The ARN identifier of the elastic cluster.

preferred_backup_window instance-attribute

preferred_backup_window: NotRequired[str]

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

preferred_maintenance_window instance-attribute

preferred_maintenance_window: NotRequired[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 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.

shard_capacity instance-attribute

shard_capacity: NotRequired[int]

The number of vCPUs assigned to each elastic cluster shard. Maximum is 64. Allowed values are 2, 4, 8, 16, 32, 64.

shard_count instance-attribute

shard_count: NotRequired[int]

The number of shards assigned to the elastic cluster. Maximum is 32.

shard_instance_count instance-attribute

shard_instance_count: NotRequired[int]

The number of replica instances applying to all shards in the elastic 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 instance-attribute

subnet_ids: NotRequired[StringList]

The Amazon EC2 subnet IDs for the elastic cluster.

vpc_security_group_ids instance-attribute

vpc_security_group_ids: NotRequired[StringList]

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