Skip to content

AvailabilityZoneInfo

Source code in docs_src/capo_opensearch/types/availability_zone_info.py
class AvailabilityZoneInfo(TypedDict, closed=True):
    availability_zone_name: NotRequired[
        "capo_opensearch.types.availability_zone.AvailabilityZone"
    ]
    """<p>The name of the Availability Zone.</p>"""
    zone_status: NotRequired["capo_opensearch.types.zone_status.ZoneStatus"]
    """<p>The current state of the Availability Zone. Current options are <code>Active</code> and <code>StandBy</code>.</p> <ul> <li> <p> <code>Active</code> - Data nodes in the Availability Zone are in use.</p> </li> <li> <p> <code>StandBy</code> - Data nodes in the Availability Zone are in a standby state.</p> </li> <li> <p> <code>NotAvailable</code> - Unable to retrieve information.</p> </li> </ul>"""
    configured_data_node_count: NotRequired[
        "capo_opensearch.types.number_of_nodes.NumberOfNodes"
    ]
    """<p>The total number of data nodes configured in the Availability Zone.</p>"""
    available_data_node_count: NotRequired[
        "capo_opensearch.types.number_of_nodes.NumberOfNodes"
    ]
    """<p>The number of data nodes active in the Availability Zone.</p>"""
    total_shards: NotRequired["capo_opensearch.types.number_of_shards.NumberOfShards"]
    """<p>The total number of primary and replica shards in the Availability Zone.</p>"""
    total_un_assigned_shards: NotRequired[
        "capo_opensearch.types.number_of_shards.NumberOfShards"
    ]
    """<p>The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.</p>"""

availability_zone_name instance-attribute

availability_zone_name: NotRequired[AvailabilityZone]

The name of the Availability Zone.

available_data_node_count instance-attribute

available_data_node_count: NotRequired[NumberOfNodes]

The number of data nodes active in the Availability Zone.

configured_data_node_count instance-attribute

configured_data_node_count: NotRequired[NumberOfNodes]

The total number of data nodes configured in the Availability Zone.

total_shards instance-attribute

total_shards: NotRequired[NumberOfShards]

The total number of primary and replica shards in the Availability Zone.

total_un_assigned_shards instance-attribute

total_un_assigned_shards: NotRequired[NumberOfShards]

The total number of primary and replica shards that aren't allocated to any of the nodes in the Availability Zone.

zone_status instance-attribute

zone_status: NotRequired[ZoneStatus]

The current state of the Availability Zone. Current options are Active and StandBy.

  • Active - Data nodes in the Availability Zone are in use.

  • StandBy - Data nodes in the Availability Zone are in a standby state.

  • NotAvailable - Unable to retrieve information.