Skip to content

DomainNodesStatus

Source code in docs_src/capo_opensearch/types/domain_nodes_status.py
class DomainNodesStatus(TypedDict, closed=True):
    node_id: NotRequired["capo_opensearch.types.node_id.NodeId"]
    """<p>The ID of the node.</p>"""
    node_type: NotRequired["capo_opensearch.types.node_type.NodeType"]
    """<p>Indicates whether the nodes is a data, master, or UltraWarm node.</p>"""
    availability_zone: NotRequired[
        "capo_opensearch.types.availability_zone.AvailabilityZone"
    ]
    """<p>The Availability Zone of the node.</p>"""
    instance_type: NotRequired[
        "capo_opensearch.types.open_search_partition_instance_type.OpenSearchPartitionInstanceType"
    ]
    """<p>The instance type information of the node.</p>"""
    node_status: NotRequired["capo_opensearch.types.node_status.NodeStatus"]
    """<p>Indicates if the node is active or in standby.</p>"""
    storage_type: NotRequired["capo_opensearch.types.storage_type_name.StorageTypeName"]
    """<p>Indicates if the node has EBS or instance storage. </p>"""
    storage_volume_type: NotRequired["capo_opensearch.types.volume_type.VolumeType"]
    """<p>If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes. </p>"""
    storage_size: NotRequired["capo_opensearch.types.volume_size.VolumeSize"]
    """<p>The storage size of the node, in GiB.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[AvailabilityZone]

The Availability Zone of the node.

instance_type instance-attribute

instance_type: NotRequired[OpenSearchPartitionInstanceType]

The instance type information of the node.

node_id instance-attribute

node_id: NotRequired[NodeId]

The ID of the node.

node_status instance-attribute

node_status: NotRequired[NodeStatus]

Indicates if the node is active or in standby.

node_type instance-attribute

node_type: NotRequired[NodeType]

Indicates whether the nodes is a data, master, or UltraWarm node.

storage_size instance-attribute

storage_size: NotRequired[VolumeSize]

The storage size of the node, in GiB.

storage_type instance-attribute

storage_type: NotRequired[StorageTypeName]

Indicates if the node has EBS or instance storage.

storage_volume_type instance-attribute

storage_volume_type: NotRequired[VolumeType]

If the nodes has EBS storage, indicates if the volume type is gp2 or gp3. Only applicable for data nodes.