Skip to content

NodeGroup

Source code in docs_src/capo_elasticache/types/node_group.py
class NodeGroup(TypedDict, closed=True):
    node_group_id: NotRequired["capo_elasticache.types.string.String"]
    """<p>The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group. </p>"""
    status: NotRequired["capo_elasticache.types.string.String"]
    """<p>The current state of this replication group - <code>creating</code>, <code>available</code>, <code>modifying</code>, <code>deleting</code>.</p>"""
    primary_endpoint: NotRequired["capo_elasticache.types.endpoint.Endpoint"]
    """<p>The endpoint of the primary node in this node group (shard).</p>"""
    reader_endpoint: NotRequired["capo_elasticache.types.endpoint.Endpoint"]
    """<p>The endpoint of the replica nodes in this node group (shard). This value is read-only.</p>"""
    slots: NotRequired["capo_elasticache.types.string.String"]
    """<p>The keyspace for this node group (shard).</p>"""
    node_group_members: NotRequired[
        "capo_elasticache.types.node_group_member_list.NodeGroupMemberList"
    ]
    """<p>A list containing information about individual nodes within the node group (shard).</p>"""

node_group_id instance-attribute

node_group_id: NotRequired[String]

The identifier for the node group (shard). A Valkey or Redis OSS (cluster mode disabled) replication group contains only 1 node group; therefore, the node group ID is 0001. A Valkey or Redis OSS (cluster mode enabled) replication group contains 1 to 90 node groups numbered 0001 to 0090. Optionally, the user can provide the id for a node group.

node_group_members instance-attribute

node_group_members: NotRequired[NodeGroupMemberList]

A list containing information about individual nodes within the node group (shard).

primary_endpoint instance-attribute

primary_endpoint: NotRequired[Endpoint]

The endpoint of the primary node in this node group (shard).

reader_endpoint instance-attribute

reader_endpoint: NotRequired[Endpoint]

The endpoint of the replica nodes in this node group (shard). This value is read-only.

slots instance-attribute

slots: NotRequired[String]

The keyspace for this node group (shard).

status instance-attribute

status: NotRequired[String]

The current state of this replication group - creating, available, modifying, deleting.