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

CreateLag

Creates a new link aggregation group (LAG) with the specified number of bundled physical connections between the customer network and a specific AWS Direct Connect location. A LAG is a logical interface that uses the Link Aggregation Control Protocol (LACP) to aggregate multiple 1 gigabit or 10 gigabit interfaces, allowing you to treat them as a single interface.

All connections in a LAG must use the same bandwidth (for example, 10 Gbps), and must terminate at the same AWS Direct Connect endpoint.

You can have up to 10 connections per LAG. Regardless of this limit, if you request more connections for the LAG than AWS Direct Connect can allocate on a single endpoint, no LAG is created.

You can specify an existing physical connection or interconnect to include in the LAG (which counts towards the total number of connections). Doing so interrupts the current physical connection or hosted connections, and re-establishes them as a member of the LAG. The LAG will be created on the same AWS Direct Connect endpoint to which the connection terminates. Any virtual interfaces associated with the connection are automatically disassociated and re-associated with the LAG. The connection ID does not change.

If the AWS account used to create a LAG is a registered AWS Direct Connect partner, the LAG is automatically enabled to host sub-connections. For a LAG owned by a partner, any associated virtual interfaces cannot be directly configured.

Request Syntax

{ "connectionId": "string", "connectionsBandwidth": "string", "lagName": "string", "location": "string", "numberOfConnections": number }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

connectionId

The ID of an existing connection to migrate to the LAG.

Default: None

Type: String

Required: No

connectionsBandwidth

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

Default: None

Available values: 1Gbps, 10Gbps

Type: String

Required: Yes

lagName

The name of the LAG.

Example: "3x10G LAG to AWS"

Default: None

Type: String

Required: Yes

location

The AWS Direct Connect location in which the LAG should be allocated.

Example: EqSV5

Default: None

Type: String

Required: Yes

numberOfConnections

The number of physical connections initially provisioned and bundled by the LAG.

Default: None

Type: Integer

Required: Yes

Response Syntax

{ "allowsHostedConnections": boolean, "awsDevice": "string", "connections": [ { "awsDevice": "string", "bandwidth": "string", "connectionId": "string", "connectionName": "string", "connectionState": "string", "lagId": "string", "loaIssueTime": number, "location": "string", "ownerAccount": "string", "partnerName": "string", "region": "string", "vlan": number } ], "connectionsBandwidth": "string", "lagId": "string", "lagName": "string", "lagState": "string", "location": "string", "minimumLinks": number, "numberOfConnections": number, "ownerAccount": "string", "region": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

allowsHostedConnections

Indicates whether the LAG can host other connections.

Note

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

Type: Boolean

awsDevice

The AWS Direct Connection endpoint that hosts the LAG.

Type: String

connections

A list of connections bundled by this LAG.

Type: Array of Connection objects

connectionsBandwidth

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

Available values: 1Gbps, 10Gbps

Type: String

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

lagName

The name of the LAG.

Type: String

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

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

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

numberOfConnections

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

Type: Integer

ownerAccount

The owner of the LAG.

Type: String

region

The AWS region where the connection is located.

Example: us-east-1

Default: None

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

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