Cluster ¶

class Cluster(TypedDict, closed=True):
    cluster_name: NotRequired["capo_dax.types.string.String"]
    """<p>The name of the DAX cluster.</p>"""
    description: NotRequired["capo_dax.types.string.String"]
    """<p>The description of the cluster.</p>"""
    cluster_arn: NotRequired["capo_dax.types.string.String"]
    """<p>The Amazon Resource Name (ARN) that uniquely identifies the cluster. </p>"""
    total_nodes: NotRequired["capo_dax.types.integer_optional.IntegerOptional"]
    """<p>The total number of nodes in the cluster.</p>"""
    active_nodes: NotRequired["capo_dax.types.integer_optional.IntegerOptional"]
    """<p>The number of nodes in the cluster that are active (i.e., capable of serving requests).</p>"""
    node_type: NotRequired["capo_dax.types.string.String"]
    """<p>The node type for the nodes in the cluster. (All nodes in a DAX cluster are of the same type.)</p>"""
    status: NotRequired["capo_dax.types.string.String"]
    """<p>The current status of the cluster.</p>"""
    cluster_discovery_endpoint: NotRequired["capo_dax.types.endpoint.Endpoint"]
    """<p>The endpoint for this DAX cluster, consisting of a DNS name, a port number, and a URL. Applications should use the URL to configure the DAX client to find their cluster.</p>"""
    node_ids_to_remove: NotRequired[
        "capo_dax.types.node_identifier_list.NodeIdentifierList"
    ]
    """<p>A list of nodes to be removed from the cluster.</p>"""
    nodes: NotRequired["capo_dax.types.node_list.NodeList"]
    """<p>A list of nodes that are currently in the cluster.</p>"""
    preferred_maintenance_window: NotRequired["capo_dax.types.string.String"]
    """<p>A range of time when maintenance of DAX cluster software will be performed. For example: <code>sun:01:00-sun:09:00</code>. Cluster maintenance normally takes less than 30 minutes, and is performed automatically within the maintenance window.</p>"""
    notification_configuration: NotRequired[
        "capo_dax.types.notification_configuration.NotificationConfiguration"
    ]
    """<p>Describes a notification topic and its status. Notification topics are used for publishing DAX events to subscribers using Amazon Simple Notification Service (SNS).</p>"""
    subnet_group: NotRequired["capo_dax.types.string.String"]
    """<p>The subnet group where the DAX cluster is running.</p>"""
    security_groups: NotRequired[
        "capo_dax.types.security_group_membership_list.SecurityGroupMembershipList"
    ]
    """<p>A list of security groups, and the status of each, for the nodes in the cluster.</p>"""
    iam_role_arn: NotRequired["capo_dax.types.string.String"]
    """<p>A valid Amazon Resource Name (ARN) that identifies an IAM role. At runtime, DAX will assume this role and use the role's permissions to access DynamoDB on your behalf.</p>"""
    parameter_group: NotRequired[
        "capo_dax.types.parameter_group_status.ParameterGroupStatus"
    ]
    """<p>The parameter group being used by nodes in the cluster.</p>"""
    sse_description: NotRequired["capo_dax.types.sse_description.SSEDescription"]
    """<p>The description of the server-side encryption status on the specified DAX cluster.</p>"""
    cluster_endpoint_encryption_type: NotRequired[
        "capo_dax.types.cluster_endpoint_encryption_type.ClusterEndpointEncryptionType"
    ]
    """<p>The type of encryption supported by the cluster's endpoint. Values are:</p> <ul> <li> <p> <code>NONE</code> for no encryption</p> <p> <code>TLS</code> for Transport Layer Security</p> </li> </ul>"""
    network_type: NotRequired["capo_dax.types.network_type.NetworkType"]
    """<p>The IP address type of the cluster. Values are:</p> <ul> <li> <p> <code>ipv4</code> - IPv4 addresses only</p> </li> <li> <p> <code>ipv6</code> - IPv6 addresses only</p> </li> <li> <p> <code>dual_stack</code> - Both IPv4 and IPv6 addresses</p> </li> </ul>"""