Cluster ¶

class Cluster(TypedDict, closed=True):
    name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The user-supplied name of the cluster. This identifier is a unique key that identifies a cluster.</p>"""
    description: NotRequired["capo_memorydb.types.string.String"]
    """<p>A description of the cluster</p>"""
    status: NotRequired["capo_memorydb.types.string.String"]
    """<p>The status of the cluster. For example, Available, Updating, Creating.</p>"""
    pending_updates: NotRequired[
        "capo_memorydb.types.cluster_pending_updates.ClusterPendingUpdates"
    ]
    """<p>A group of settings that are currently being applied.</p>"""
    multi_region_cluster_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the multi-Region cluster that this cluster belongs to.</p>"""
    number_of_shards: NotRequired[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of shards in the cluster</p>"""
    shards: NotRequired["capo_memorydb.types.shard_list.ShardList"]
    """<p>A list of shards that are members of the cluster.</p>"""
    availability_mode: NotRequired["capo_memorydb.types.az_status.AZStatus"]
    """<p>Indicates if the cluster has a Multi-AZ configuration (multiaz) or not (singleaz).</p>"""
    cluster_endpoint: NotRequired["capo_memorydb.types.endpoint.Endpoint"]
    """<p>The cluster's configuration endpoint</p>"""
    node_type: NotRequired["capo_memorydb.types.string.String"]
    """<p>The cluster's node type</p>"""
    engine: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the engine used by the cluster.</p>"""
    engine_version: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Redis OSS engine version used by the cluster</p>"""
    engine_patch_version: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Redis OSS engine patch version used by the cluster</p>"""
    parameter_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the parameter group used by the cluster</p>"""
    parameter_group_status: NotRequired["capo_memorydb.types.string.String"]
    """<p>The status of the parameter group used by the cluster, for example 'active' or 'applying'.</p>"""
    security_groups: NotRequired[
        "capo_memorydb.types.security_group_membership_list.SecurityGroupMembershipList"
    ]
    """<p>A list of security groups used by the cluster</p>"""
    subnet_group_name: NotRequired["capo_memorydb.types.string.String"]
    """<p>The name of the subnet group used by the cluster</p>"""
    tls_enabled: NotRequired["capo_memorydb.types.boolean_optional.BooleanOptional"]
    """<p>A flag to indicate if In-transit encryption is enabled</p>"""
    kms_key_id: NotRequired["capo_memorydb.types.string.String"]
    """<p>The ID of the KMS key used to encrypt the cluster</p>"""
    arn: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the cluster.</p>"""
    sns_topic_arn: NotRequired["capo_memorydb.types.string.String"]
    """<p>The Amazon Resource Name (ARN) of the SNS notification topic</p>"""
    sns_topic_status: NotRequired["capo_memorydb.types.string.String"]
    """<p>The SNS topic must be in Active status to receive notifications</p>"""
    snapshot_retention_limit: NotRequired[
        "capo_memorydb.types.integer_optional.IntegerOptional"
    ]
    """<p>The number of days for which MemoryDB retains automatic snapshots before deleting them. For example, if you set SnapshotRetentionLimit to 5, a snapshot that was taken today is retained for 5 days before being deleted.</p>"""
    maintenance_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>Specifies the weekly time range during which maintenance on the cluster is performed. It is specified as a range in the format ddd:hh24:mi-ddd:hh24:mi (24H Clock UTC). The minimum maintenance window is a 60 minute period. </p>"""
    snapshot_window: NotRequired["capo_memorydb.types.string.String"]
    """<p>The daily time range (in UTC) during which MemoryDB begins taking a daily snapshot of your shard. Example: 05:00-09:00 If you do not specify this parameter, MemoryDB automatically chooses an appropriate time range.</p>"""
    acl_name: NotRequired["capo_memorydb.types.acl_name.ACLName"]
    """<p>The name of the Access Control List associated with this cluster.</p>"""
    auto_minor_version_upgrade: NotRequired[
        "capo_memorydb.types.boolean_optional.BooleanOptional"
    ]
    """<p>When set to true, the cluster will automatically receive minor engine version upgrades after launch.</p>"""
    data_tiering: NotRequired[
        "capo_memorydb.types.data_tiering_status.DataTieringStatus"
    ]
    """<p>Enables data tiering. Data tiering is only supported for clusters using the r6gd node type. This parameter must be set when using r6gd nodes. For more information, see <a href="https://docs.aws.amazon.com/memorydb/latest/devguide/data-tiering.html">Data tiering</a>.</p>"""
    network_type: NotRequired["capo_memorydb.types.network_type.NetworkType"]
    """<p>The IP address type for the cluster. Returns 'ipv4' for IPv4 only, 'ipv6' for IPv6 only, or 'dual-stack' if the cluster supports both IPv4 and IPv6 addressing.</p>"""
    ip_discovery: NotRequired["capo_memorydb.types.ip_discovery.IpDiscovery"]
    """<p>The mechanism that the cluster uses to discover IP addresses. Returns 'ipv4' when DNS endpoints resolve to IPv4 addresses, or 'ipv6' when DNS endpoints resolve to IPv6 addresses.</p>"""