Skip to content

DirectConnectGatewayAttachment

Source code in docs_src/capo_direct_connect/types/direct_connect_gateway_attachment.py
class DirectConnectGatewayAttachment(TypedDict, closed=True):
    direct_connect_gateway_id: NotRequired[
        "capo_direct_connect.types.direct_connect_gateway_id.DirectConnectGatewayId"
    ]
    """<p>The ID of the Direct Connect gateway.</p>"""
    virtual_interface_id: NotRequired[
        "capo_direct_connect.types.virtual_interface_id.VirtualInterfaceId"
    ]
    """<p>The ID of the virtual interface.</p>"""
    virtual_interface_region: NotRequired[
        "capo_direct_connect.types.virtual_interface_region.VirtualInterfaceRegion"
    ]
    """<p>The Amazon Web Services Region where the virtual interface is located.</p>"""
    virtual_interface_owner_account: NotRequired[
        "capo_direct_connect.types.owner_account.OwnerAccount"
    ]
    """<p>The ID of the Amazon Web Services account that owns the virtual interface.</p>"""
    attachment_state: NotRequired[
        "capo_direct_connect.types.direct_connect_gateway_attachment_state.DirectConnectGatewayAttachmentState"
    ]
    """<p>The state of the attachment. The following are the possible values:</p> <ul> <li> <p> <code>attaching</code>: The initial state after a virtual interface is created using the Direct Connect gateway.</p> </li> <li> <p> <code>attached</code>: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.</p> </li> <li> <p> <code>detaching</code>: The initial state after calling <a>DeleteVirtualInterface</a>.</p> </li> <li> <p> <code>detached</code>: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.</p> </li> </ul>"""
    attachment_type: NotRequired[
        "capo_direct_connect.types.direct_connect_gateway_attachment_type.DirectConnectGatewayAttachmentType"
    ]
    """<p>The type of attachment.</p>"""
    state_change_error: NotRequired[
        "capo_direct_connect.types.state_change_error.StateChangeError"
    ]
    """<p>The error message if the state of an object failed to advance.</p>"""

attachment_state instance-attribute

attachment_state: NotRequired[DirectConnectGatewayAttachmentState]

The state of the attachment. The following are the possible values:

  • attaching: The initial state after a virtual interface is created using the Direct Connect gateway.

  • attached: The Direct Connect gateway and virtual interface are attached and ready to pass traffic.

  • detaching: The initial state after calling DeleteVirtualInterface.

  • detached: The virtual interface is detached from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual interface is stopped.

attachment_type instance-attribute

attachment_type: NotRequired[DirectConnectGatewayAttachmentType]

The type of attachment.

direct_connect_gateway_id instance-attribute

direct_connect_gateway_id: NotRequired[DirectConnectGatewayId]

The ID of the Direct Connect gateway.

state_change_error instance-attribute

state_change_error: NotRequired[StateChangeError]

The error message if the state of an object failed to advance.

virtual_interface_id instance-attribute

virtual_interface_id: NotRequired[VirtualInterfaceId]

The ID of the virtual interface.

virtual_interface_owner_account instance-attribute

virtual_interface_owner_account: NotRequired[OwnerAccount]

The ID of the Amazon Web Services account that owns the virtual interface.

virtual_interface_region instance-attribute

virtual_interface_region: NotRequired[VirtualInterfaceRegion]

The Amazon Web Services Region where the virtual interface is located.