Skip to content

Connection

Source code in docs_src/capo_direct_connect/types/connection.py
class Connection(TypedDict, closed=True):
    owner_account: NotRequired["capo_direct_connect.types.owner_account.OwnerAccount"]
    """<p>The ID of the Amazon Web Services account that owns the connection.</p>"""
    connection_id: NotRequired["capo_direct_connect.types.connection_id.ConnectionId"]
    """<p>The ID of the connection.</p>"""
    connection_name: NotRequired[
        "capo_direct_connect.types.connection_name.ConnectionName"
    ]
    """<p>The name of the connection.</p>"""
    connection_state: NotRequired[
        "capo_direct_connect.types.connection_state.ConnectionState"
    ]
    """<p>The state of the connection. The following are the possible values:</p> <ul> <li> <p> <code>ordering</code>: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.</p> </li> <li> <p> <code>requested</code>: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.</p> </li> <li> <p> <code>pending</code>: The connection has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is up and the connection is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The connection is being deleted.</p> </li> <li> <p> <code>deleted</code>: The connection has been deleted.</p> </li> <li> <p> <code>rejected</code>: A hosted connection in the <code>ordering</code> state enters the <code>rejected</code> state if it is deleted by the customer.</p> </li> <li> <p> <code>unknown</code>: The state of the connection is not available.</p> </li> </ul>"""
    region: NotRequired["capo_direct_connect.types.region.Region"]
    """<p>The Amazon Web Services Region where the connection is located.</p>"""
    location: NotRequired["capo_direct_connect.types.location_code.LocationCode"]
    """<p>The location of the connection.</p>"""
    bandwidth: NotRequired["capo_direct_connect.types.bandwidth.Bandwidth"]
    """<p>The bandwidth of the connection.</p>"""
    vlan: "capo_direct_connect.types.vlan.VLAN"
    """<p>The ID of the VLAN.</p>"""
    partner_name: NotRequired["capo_direct_connect.types.partner_name.PartnerName"]
    """<p>The name of the Direct Connect service provider associated with the connection.</p>"""
    loa_issue_time: NotRequired["capo_direct_connect.types.loa_issue_time.LoaIssueTime"]
    """<p>The time of the most recent call to <a>DescribeLoa</a> for this connection.</p>"""
    lag_id: NotRequired["capo_direct_connect.types.lag_id.LagId"]
    """<p>The ID of the LAG.</p>"""
    aws_device: NotRequired["capo_direct_connect.types.aws_device.AwsDevice"]
    """<p>The Direct Connect endpoint on which the physical connection terminates.</p>"""
    jumbo_frame_capable: NotRequired[
        "capo_direct_connect.types.jumbo_frame_capable.JumboFrameCapable"
    ]
    """<p>Indicates whether jumbo frames are supported.</p>"""
    aws_device_v2: NotRequired["capo_direct_connect.types.aws_device_v2.AwsDeviceV2"]
    """<p>The Direct Connect endpoint that terminates the physical connection.</p>"""
    aws_logical_device_id: NotRequired[
        "capo_direct_connect.types.aws_logical_device_id.AwsLogicalDeviceId"
    ]
    """<p>The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.</p>"""
    has_logical_redundancy: NotRequired[
        "capo_direct_connect.types.has_logical_redundancy.HasLogicalRedundancy"
    ]
    """<p>Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).</p>"""
    tags: NotRequired["capo_direct_connect.types.tag_list.TagList"]
    """<p>The tags associated with the connection.</p>"""
    provider_name: NotRequired["capo_direct_connect.types.provider_name.ProviderName"]
    """<p>The name of the service provider associated with the connection.</p>"""
    mac_sec_capable: NotRequired[
        "capo_direct_connect.types.mac_sec_capable.MacSecCapable"
    ]
    """<p>Indicates whether the connection supports MAC Security (MACsec).</p>"""
    port_encryption_status: NotRequired[
        "capo_direct_connect.types.port_encryption_status.PortEncryptionStatus"
    ]
    """<p>The MAC Security (MACsec) port link status of the connection.</p> <p>The valid values are <code>Encryption Up</code>, which means that there is an active Connection Key Name, or <code>Encryption Down</code>.</p>"""
    encryption_mode: NotRequired[
        "capo_direct_connect.types.encryption_mode.EncryptionMode"
    ]
    """<p>The MAC Security (MACsec) connection encryption mode.</p> <p>The valid values are <code>no_encrypt</code>, <code>should_encrypt</code>, and <code>must_encrypt</code>.</p>"""
    mac_sec_keys: NotRequired[
        "capo_direct_connect.types.mac_sec_key_list.MacSecKeyList"
    ]
    """<p>The MAC Security (MACsec) security keys associated with the connection.</p>"""
    rate_limiter_status: NotRequired[
        "capo_direct_connect.types.rate_limiter_status.RateLimiterStatus"
    ]
    """<p>The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.</p>"""
    partner_interconnect_mac_sec_capable: NotRequired[
        "capo_direct_connect.types.partner_interconnect_mac_sec_capable.PartnerInterconnectMacSecCapable"
    ]
    """<p>Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).</p>"""
    prefix_pool_size_ipv4: NotRequired[
        "capo_direct_connect.types.prefix_pool_size.PrefixPoolSize"
    ]
    """<p>The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.</p>"""
    prefix_pool_size_ipv6: NotRequired[
        "capo_direct_connect.types.prefix_pool_size.PrefixPoolSize"
    ]
    """<p>The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.</p>"""
    prefix_pool_unallocated_count_ipv4: NotRequired[
        "capo_direct_connect.types.prefix_pool_unallocated_count.PrefixPoolUnallocatedCount"
    ]
    """<p>The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.</p>"""
    prefix_pool_unallocated_count_ipv6: NotRequired[
        "capo_direct_connect.types.prefix_pool_unallocated_count.PrefixPoolUnallocatedCount"
    ]
    """<p>The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.</p>"""
    billing_mode: NotRequired["capo_direct_connect.types.billing_mode.BillingMode"]
    """<p>The billing mode of the connection.</p>"""

aws_device instance-attribute

aws_device: NotRequired[AwsDevice]

The Direct Connect endpoint on which the physical connection terminates.

aws_device_v2 instance-attribute

aws_device_v2: NotRequired[AwsDeviceV2]

The Direct Connect endpoint that terminates the physical connection.

aws_logical_device_id instance-attribute

aws_logical_device_id: NotRequired[AwsLogicalDeviceId]

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

bandwidth instance-attribute

bandwidth: NotRequired[Bandwidth]

The bandwidth of the connection.

billing_mode instance-attribute

billing_mode: NotRequired[BillingMode]

The billing mode of the connection.

connection_id instance-attribute

connection_id: NotRequired[ConnectionId]

The ID of the connection.

connection_name instance-attribute

connection_name: NotRequired[ConnectionName]

The name of the connection.

connection_state instance-attribute

connection_state: NotRequired[ConnectionState]

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

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

encryption_mode instance-attribute

encryption_mode: NotRequired[EncryptionMode]

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

has_logical_redundancy instance-attribute

has_logical_redundancy: NotRequired[HasLogicalRedundancy]

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumbo_frame_capable instance-attribute

jumbo_frame_capable: NotRequired[JumboFrameCapable]

Indicates whether jumbo frames are supported.

lag_id instance-attribute

lag_id: NotRequired[LagId]

The ID of the LAG.

loa_issue_time instance-attribute

loa_issue_time: NotRequired[LoaIssueTime]

The time of the most recent call to DescribeLoa for this connection.

location instance-attribute

location: NotRequired[LocationCode]

The location of the connection.

mac_sec_capable instance-attribute

mac_sec_capable: NotRequired[MacSecCapable]

Indicates whether the connection supports MAC Security (MACsec).

mac_sec_keys instance-attribute

mac_sec_keys: NotRequired[MacSecKeyList]

The MAC Security (MACsec) security keys associated with the connection.

owner_account instance-attribute

owner_account: NotRequired[OwnerAccount]

The ID of the Amazon Web Services account that owns the connection.

partner_interconnect_mac_sec_capable instance-attribute

partner_interconnect_mac_sec_capable: NotRequired[PartnerInterconnectMacSecCapable]

Indicates whether the interconnect hosting this connection supports MAC Security (MACsec).

partner_name instance-attribute

partner_name: NotRequired[PartnerName]

The name of the Direct Connect service provider associated with the connection.

port_encryption_status instance-attribute

port_encryption_status: NotRequired[PortEncryptionStatus]

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

prefix_pool_size_ipv4 instance-attribute

prefix_pool_size_ipv4: NotRequired[PrefixPoolSize]

The total number of inbound IPv4 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.

prefix_pool_size_ipv6 instance-attribute

prefix_pool_size_ipv6: NotRequired[PrefixPoolSize]

The total number of inbound IPv6 route prefixes you can allocate across the virtual interfaces on the connection. Not applicable to hosted connections or interconnects.

prefix_pool_unallocated_count_ipv4 instance-attribute

prefix_pool_unallocated_count_ipv4: NotRequired[PrefixPoolUnallocatedCount]

The number of inbound IPv4 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.

prefix_pool_unallocated_count_ipv6 instance-attribute

prefix_pool_unallocated_count_ipv6: NotRequired[PrefixPoolUnallocatedCount]

The number of inbound IPv6 route prefixes in the connection prefix pool not yet allocated to a virtual interface. Not applicable to hosted connections or interconnects.

provider_name instance-attribute

provider_name: NotRequired[ProviderName]

The name of the service provider associated with the connection.

rate_limiter_status instance-attribute

rate_limiter_status: NotRequired[RateLimiterStatus]

The rate limiter status for the connection, including how many rate limiters are in use and the maximum allowed.

region instance-attribute

region: NotRequired[Region]

The Amazon Web Services Region where the connection is located.

tags instance-attribute

tags: NotRequired[TagList]

The tags associated with the connection.

vlan instance-attribute

vlan: VLAN

The ID of the VLAN.