Skip to content

GatewayInstance

Source code in docs_src/capo_mediaconnect/types/gateway_instance.py
class GatewayInstance(TypedDict, closed=True):
    bridge_placement: NotRequired[
        "capo_mediaconnect.types.bridge_placement.BridgePlacement"
    ]
    """<p>The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance. </p>"""
    connection_status: NotRequired[
        "capo_mediaconnect.types.connection_status.ConnectionStatus"
    ]
    """<p>The connection state of the instance. </p>"""
    gateway_arn: NotRequired["str"]
    """<p>The Amazon Resource Name (ARN) of the instance. </p>"""
    gateway_instance_arn: NotRequired["str"]
    """<p>The ARN of the gateway. </p>"""
    instance_id: NotRequired["str"]
    """<p>The instance ID generated by the SSM install. This will begin with "mi-". </p>"""
    instance_messages: NotRequired[
        "capo_mediaconnect.types.__list_of_message_detail.__listOfMessageDetail"
    ]
    """<p> Messages with information about the gateway. </p>"""
    instance_state: NotRequired["capo_mediaconnect.types.instance_state.InstanceState"]
    """<p>The status of the instance. </p>"""
    running_bridge_count: NotRequired["int"]
    """<p> The running bridge count. </p>"""

bridge_placement instance-attribute

bridge_placement: NotRequired[BridgePlacement]

The availability of the instance to host new bridges. The bridgePlacement property can be LOCKED or AVAILABLE. If it is LOCKED, no new bridges can be deployed to this instance. If it is AVAILABLE, new bridges can be deployed to this instance.

connection_status instance-attribute

connection_status: NotRequired[ConnectionStatus]

The connection state of the instance.

gateway_arn instance-attribute

gateway_arn: NotRequired[str]

The Amazon Resource Name (ARN) of the instance.

gateway_instance_arn instance-attribute

gateway_instance_arn: NotRequired[str]

The ARN of the gateway.

instance_id instance-attribute

instance_id: NotRequired[str]

The instance ID generated by the SSM install. This will begin with "mi-".

instance_messages instance-attribute

instance_messages: NotRequired[__listOfMessageDetail]

Messages with information about the gateway.

instance_state instance-attribute

instance_state: NotRequired[InstanceState]

The status of the instance.

running_bridge_count instance-attribute

running_bridge_count: NotRequired[int]

The running bridge count.