Skip to content

DirectConnectGateway

Source code in docs_src/capo_direct_connect/types/direct_connect_gateway.py
class DirectConnectGateway(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>"""
    direct_connect_gateway_name: NotRequired[
        "capo_direct_connect.types.direct_connect_gateway_name.DirectConnectGatewayName"
    ]
    """<p>The name of the Direct Connect gateway.</p>"""
    amazon_side_asn: NotRequired["capo_direct_connect.types.long_asn.LongAsn"]
    """<p>The autonomous system number (AS) for the Amazon side of the connection.</p>"""
    owner_account: NotRequired["capo_direct_connect.types.owner_account.OwnerAccount"]
    """<p>The ID of the Amazon Web Services account that owns the Direct Connect gateway.</p>"""
    direct_connect_gateway_state: NotRequired[
        "capo_direct_connect.types.direct_connect_gateway_state.DirectConnectGatewayState"
    ]
    """<p>The state of the Direct Connect gateway. The following are the possible values:</p> <ul> <li> <p> <code>pending</code>: The initial state after calling <a>CreateDirectConnectGateway</a>.</p> </li> <li> <p> <code>available</code>: The Direct Connect gateway is ready for use.</p> </li> <li> <p> <code>deleting</code>: The initial state after calling <a>DeleteDirectConnectGateway</a>.</p> </li> <li> <p> <code>deleted</code>: The Direct Connect gateway is deleted and cannot pass traffic.</p> </li> </ul>"""
    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>"""
    total_prefix_pool_allocations: NotRequired[
        "capo_direct_connect.types.prefix_pool_allocated_count.PrefixPoolAllocatedCount"
    ]
    """<p>The total number of inbound route prefixes allocated to the attachments on the Direct Connect gateway. The count combines the IPv4 and IPv6 address families.</p>"""
    tags: NotRequired["capo_direct_connect.types.tag_list.TagList"]
    """<p>Information about a tag.</p>"""

amazon_side_asn instance-attribute

amazon_side_asn: NotRequired[LongAsn]

The autonomous system number (AS) for the Amazon side of the connection.

direct_connect_gateway_id instance-attribute

direct_connect_gateway_id: NotRequired[DirectConnectGatewayId]

The ID of the Direct Connect gateway.

direct_connect_gateway_name instance-attribute

direct_connect_gateway_name: NotRequired[DirectConnectGatewayName]

The name of the Direct Connect gateway.

direct_connect_gateway_state instance-attribute

direct_connect_gateway_state: NotRequired[DirectConnectGatewayState]

The state of the Direct Connect gateway. The following are the possible values:

  • pending: The initial state after calling CreateDirectConnectGateway.

  • available: The Direct Connect gateway is ready for use.

  • deleting: The initial state after calling DeleteDirectConnectGateway.

  • deleted: The Direct Connect gateway is deleted and cannot pass traffic.

owner_account instance-attribute

owner_account: NotRequired[OwnerAccount]

The ID of the Amazon Web Services account that owns 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.

tags instance-attribute

tags: NotRequired[TagList]

Information about a tag.

total_prefix_pool_allocations instance-attribute

total_prefix_pool_allocations: NotRequired[PrefixPoolAllocatedCount]

The total number of inbound route prefixes allocated to the attachments on the Direct Connect gateway. The count combines the IPv4 and IPv6 address families.