Menu
AWS Direct Connect
API Reference (API Version 2012-10-25)

Lag

Describes a link aggregation group (LAG). A LAG is a connection that uses the Link Aggregation Control Protocol (LACP) to logically aggregate a bundle of physical connections. Like an interconnect, it can host other connections. All connections in a LAG must terminate on the same physical AWS Direct Connect endpoint, and must be the same bandwidth.

Contents

allowsHostedConnections

Indicates whether the LAG can host other connections.

Note

This is intended for use by AWS Direct Connect partners only.

Type: Boolean

Required: No

awsDevice

The AWS Direct Connection endpoint that hosts the LAG.

Type: String

Required: No

connections

A list of connections bundled by this LAG.

Type: Array of Connection objects

Required: No

connectionsBandwidth

The individual bandwidth of the physical connections bundled by the LAG.

Available values: 1Gbps, 10Gbps

Type: String

Required: No

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

Required: No

lagName

The name of the LAG.

Type: String

Required: No

lagState

The state of the LAG.

  • 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 in the process of being deleted.

  • Deleted: The LAG has been deleted.

Type: String

Valid Values: requested | pending | available | down | deleting | deleted

Required: No

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

Required: No

minimumLinks

The minimum number of physical connections that must be operational for the LAG itself to be operational. If the number of operational connections drops below this setting, the LAG state changes to down. This value can help to ensure that a LAG is not overutilized if a significant number of its bundled connections go down.

Type: Integer

Required: No

numberOfConnections

The number of physical connections bundled by the LAG, up to a maximum of 10.

Type: Integer

Required: No

ownerAccount

The owner of the LAG.

Type: String

Required: No

region

The AWS region where the connection is located.

Example: us-east-1

Default: None

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: