Cluster ¶

class Cluster(TypedDict, closed=True):
    cluster_name: "str"
    """<p>The name of the elastic cluster.</p>"""
    cluster_arn: "str"
    """<p>The ARN identifier of the elastic cluster.</p>"""
    status: "capo_docdb_elastic.types.status.Status"
    """<p>The status of the elastic cluster.</p>"""
    cluster_endpoint: "str"
    """<p>The URL used to connect to the elastic cluster.</p>"""
    create_time: "str"
    """<p>The time when the elastic cluster was created in Universal Coordinated Time (UTC).</p>"""
    admin_user_name: "str"
    """<p>The name of the elastic cluster administrator.</p>"""
    auth_type: "capo_docdb_elastic.types.auth.Auth"
    """<p>The authentication type for the elastic cluster.</p>"""
    shard_capacity: "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: "int"
    """<p>The number of shards assigned to the elastic cluster. Maximum is 32.</p>"""
    vpc_security_group_ids: "capo_docdb_elastic.types.string_list.StringList"
    """<p>A list of EC2 VPC security groups associated with thie elastic cluster.</p>"""
    subnet_ids: "capo_docdb_elastic.types.string_list.StringList"
    """<p>The Amazon EC2 subnet IDs for the elastic cluster.</p>"""
    preferred_maintenance_window: "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>"""
    kms_key_id: "str"
    """<p>The KMS key identifier to use to encrypt the elastic cluster.</p>"""
    shards: NotRequired["capo_docdb_elastic.types.shard_list.ShardList"]
    """<p>The total number of shards in the cluster.</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 <code>backupRetentionPeriod</code>.</p>"""
    shard_instance_count: NotRequired["int"]
    """<p>The number of replica instances applying to all shards in the 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>"""