Skip to content

Lag

Source code in docs_src/capo_direct_connect/types/lag.py
class Lag(TypedDict, closed=True):
    connections_bandwidth: NotRequired["capo_direct_connect.types.bandwidth.Bandwidth"]
    """<p>The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps.. </p>"""
    number_of_connections: "capo_direct_connect.types.count.Count"
    """<p>The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.</p>"""
    lag_id: NotRequired["capo_direct_connect.types.lag_id.LagId"]
    """<p>The ID of the LAG.</p>"""
    owner_account: NotRequired["capo_direct_connect.types.owner_account.OwnerAccount"]
    """<p>The ID of the Amazon Web Services account that owns the LAG.</p>"""
    lag_name: NotRequired["capo_direct_connect.types.lag_name.LagName"]
    """<p>The name of the LAG.</p>"""
    lag_state: NotRequired["capo_direct_connect.types.lag_state.LagState"]
    """<p>The state of the LAG. The following are the possible values:</p> <ul> <li> <p> <code>requested</code>: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.</p> </li> <li> <p> <code>pending</code>: The LAG has been approved and is being initialized.</p> </li> <li> <p> <code>available</code>: The network link is established and the LAG is ready for use.</p> </li> <li> <p> <code>down</code>: The network link is down.</p> </li> <li> <p> <code>deleting</code>: The LAG is being deleted.</p> </li> <li> <p> <code>deleted</code>: The LAG is deleted.</p> </li> <li> <p> <code>unknown</code>: The state of the LAG is not available.</p> </li> </ul>"""
    location: NotRequired["capo_direct_connect.types.location_code.LocationCode"]
    """<p>The location of the LAG.</p>"""
    region: NotRequired["capo_direct_connect.types.region.Region"]
    """<p>The Amazon Web Services Region where the connection is located.</p>"""
    minimum_links: "capo_direct_connect.types.count.Count"
    """<p>The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.</p>"""
    aws_device: NotRequired["capo_direct_connect.types.aws_device.AwsDevice"]
    """<p>The Direct Connect endpoint that hosts the LAG.</p>"""
    aws_device_v2: NotRequired["capo_direct_connect.types.aws_device_v2.AwsDeviceV2"]
    """<p>The Direct Connect endpoint that hosts the LAG.</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>"""
    connections: NotRequired["capo_direct_connect.types.connection_list.ConnectionList"]
    """<p>The connections bundled by the LAG.</p>"""
    allows_hosted_connections: "capo_direct_connect.types.boolean_flag.BooleanFlag"
    """<p>Indicates whether the LAG can host other connections.</p>"""
    jumbo_frame_capable: NotRequired[
        "capo_direct_connect.types.jumbo_frame_capable.JumboFrameCapable"
    ]
    """<p>Indicates whether jumbo frames are supported.</p>"""
    has_logical_redundancy: NotRequired[
        "capo_direct_connect.types.has_logical_redundancy.HasLogicalRedundancy"
    ]
    """<p>Indicates whether the LAG 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 LAG.</p>"""
    provider_name: NotRequired["capo_direct_connect.types.provider_name.ProviderName"]
    """<p>The name of the service provider associated with the LAG.</p>"""
    mac_sec_capable: NotRequired[
        "capo_direct_connect.types.mac_sec_capable.MacSecCapable"
    ]
    """<p>Indicates whether the LAG supports MAC Security (MACsec).</p>"""
    encryption_mode: NotRequired[
        "capo_direct_connect.types.encryption_mode.EncryptionMode"
    ]
    """<p>The LAG MAC Security (MACsec) 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 LAG.</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 LAG. Not applicable to LAGs that are interconnects and support hosted connections.</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 LAG. Not applicable to LAGs that are interconnects and support hosted connections.</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 LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.</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 LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.</p>"""
    rate_limiter_status: NotRequired[
        "capo_direct_connect.types.rate_limiter_status.RateLimiterStatus"
    ]
    """<p>The rate limiter status for the LAG, including how many rate limiters are in use and the maximum allowed.</p>"""
    billing_mode: NotRequired["capo_direct_connect.types.billing_mode.BillingMode"]
    """<p>The billing mode of the LAG.</p>"""

allows_hosted_connections instance-attribute

allows_hosted_connections: BooleanFlag

Indicates whether the LAG can host other connections.

aws_device instance-attribute

aws_device: NotRequired[AwsDevice]

The Direct Connect endpoint that hosts the LAG.

aws_device_v2 instance-attribute

aws_device_v2: NotRequired[AwsDeviceV2]

The Direct Connect endpoint that hosts the LAG.

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.

billing_mode instance-attribute

billing_mode: NotRequired[BillingMode]

The billing mode of the LAG.

connections instance-attribute

connections: NotRequired[ConnectionList]

The connections bundled by the LAG.

connections_bandwidth instance-attribute

connections_bandwidth: NotRequired[Bandwidth]

The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..

encryption_mode instance-attribute

encryption_mode: NotRequired[EncryptionMode]

The LAG MAC Security (MACsec) 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 LAG 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.

lag_name instance-attribute

lag_name: NotRequired[LagName]

The name of the LAG.

lag_state instance-attribute

lag_state: NotRequired[LagState]

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

  • requested: The initial state of a LAG. The LAG stays in the requested state until the Letter of Authorization (LOA) is available.

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

  • available: The network link is established and the LAG is ready for use.

  • down: The network link is down.

  • deleting: The LAG is being deleted.

  • deleted: The LAG is deleted.

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

location instance-attribute

location: NotRequired[LocationCode]

The location of the LAG.

mac_sec_capable instance-attribute

mac_sec_capable: NotRequired[MacSecCapable]

Indicates whether the LAG supports MAC Security (MACsec).

mac_sec_keys instance-attribute

mac_sec_keys: NotRequired[MacSecKeyList]

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

minimum_links: Count

The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.

number_of_connections instance-attribute

number_of_connections: Count

The number of physical dedicated connections initially provisioned and bundled by the LAG. You can have a maximum of four connections when the port speed is 1 Gbps or 10 Gbps, or two when the port speed is 100 Gbps or 400 Gbps.

owner_account instance-attribute

owner_account: NotRequired[OwnerAccount]

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

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 LAG. Not applicable to LAGs that are interconnects and support hosted connections.

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 LAG. Not applicable to LAGs that are interconnects and support hosted connections.

prefix_pool_unallocated_count_ipv4 instance-attribute

prefix_pool_unallocated_count_ipv4: NotRequired[PrefixPoolUnallocatedCount]

The number of inbound IPv4 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.

prefix_pool_unallocated_count_ipv6 instance-attribute

prefix_pool_unallocated_count_ipv6: NotRequired[PrefixPoolUnallocatedCount]

The number of inbound IPv6 route prefixes in the LAG prefix pool not yet allocated to a virtual interface. Not applicable to LAGs that are interconnects and support hosted connections.

provider_name instance-attribute

provider_name: NotRequired[ProviderName]

The name of the service provider associated with the LAG.

rate_limiter_status instance-attribute

rate_limiter_status: NotRequired[RateLimiterStatus]

The rate limiter status for the LAG, 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 LAG.