Skip to content

InstanceTopology

Source code in docs_src/capo_ec2/types/instance_topology.py
class InstanceTopology(TypedDict, closed=True):
    instance_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The instance ID.</p>"""
    instance_type: NotRequired["capo_ec2.types.string.String"]
    """<p>The instance type.</p>"""
    group_name: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the placement group that the instance is in.</p>"""
    network_nodes: NotRequired["capo_ec2.types.network_nodes_list.NetworkNodesList"]
    """<p>The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.</p> <p>The value is <code>null</code> or empty if:</p> <ul> <li> <p>The instance type is not supported.</p> </li> <li> <p>The instance is in a state other than <code>running</code>.</p> </li> </ul>"""
    availability_zone: NotRequired["capo_ec2.types.string.String"]
    """<p>The name of the Availability Zone or Local Zone that the instance is in.</p>"""
    zone_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Availability Zone or Local Zone that the instance is in.</p>"""
    capacity_block_id: NotRequired["capo_ec2.types.string.String"]
    """<p>The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.</p>"""

availability_zone instance-attribute

availability_zone: NotRequired[String]

The name of the Availability Zone or Local Zone that the instance is in.

capacity_block_id instance-attribute

capacity_block_id: NotRequired[String]

The ID of the Capacity Block. This parameter is only supported for UltraServer instances and identifies instances within the UltraServer domain.

group_name instance-attribute

group_name: NotRequired[String]

The name of the placement group that the instance is in.

instance_id instance-attribute

instance_id: NotRequired[String]

The instance ID.

instance_type instance-attribute

instance_type: NotRequired[String]

The instance type.

network_nodes instance-attribute

network_nodes: NotRequired[NetworkNodesList]

The network nodes. The nodes are hashed based on your account. Instances from different accounts running under the same server will return a different hashed list of strings.

The value is null or empty if:

  • The instance type is not supported.

  • The instance is in a state other than running.

zone_id instance-attribute

zone_id: NotRequired[String]

The ID of the Availability Zone or Local Zone that the instance is in.