UpdateLag
Updates the attributes of the specified link aggregation group (LAG).
You can update the following LAG attributes:
-
The name of the LAG.
-
The value for the minimum number of connections that must be operational for the LAG itself to be operational.
-
The LAG's MACsec encryption mode.
AWS assigns this value to each connection which is part of the LAG.
-
The tags
Note
If you adjust the threshold value for the minimum number of operational connections, ensure that the new value does not cause the LAG to fall below the threshold and become non-operational.
Request Syntax
{
"encryptionMode": "string",
"lagId": "string",
"lagName": "string",
"minimumLinks": 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.
- encryptionMode
-
The LAG MAC Security (MACsec) encryption mode.
AWS applies the value to all connections which are part of the LAG.
Type: String
Required: No
- lagId
-
The ID of the LAG.
Type: String
Required: Yes
- lagName
-
The name of the LAG.
Type: String
Required: No
- minimumLinks
-
The minimum number of physical connections that must be operational for the LAG itself to be operational.
Type: Integer
Required: No
Response Syntax
{
"allowsHostedConnections": boolean,
"awsDevice": "string",
"awsDeviceV2": "string",
"awsLogicalDeviceId": "string",
"connections": [
{
"awsDevice": "string",
"awsDeviceV2": "string",
"awsLogicalDeviceId": "string",
"bandwidth": "string",
"connectionId": "string",
"connectionName": "string",
"connectionState": "string",
"encryptionMode": "string",
"hasLogicalRedundancy": "string",
"jumboFrameCapable": boolean,
"lagId": "string",
"loaIssueTime": number,
"location": "string",
"macSecCapable": boolean,
"macSecKeys": [
{
"ckn": "string",
"secretARN": "string",
"startOn": "string",
"state": "string"
}
],
"ownerAccount": "string",
"partnerName": "string",
"portEncryptionStatus": "string",
"providerName": "string",
"region": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"vlan": number
}
],
"connectionsBandwidth": "string",
"encryptionMode": "string",
"hasLogicalRedundancy": "string",
"jumboFrameCapable": boolean,
"lagId": "string",
"lagName": "string",
"lagState": "string",
"location": "string",
"macSecCapable": boolean,
"macSecKeys": [
{
"ckn": "string",
"secretARN": "string",
"startOn": "string",
"state": "string"
}
],
"minimumLinks": number,
"numberOfConnections": number,
"ownerAccount": "string",
"providerName": "string",
"region": "string",
"tags": [
{
"key": "string",
"value": "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.
Type: Boolean
- awsDevice
-
This parameter has been deprecated.
The AWS Direct Connect endpoint that hosts the LAG.
Type: String
- awsDeviceV2
-
The AWS Direct Connect endpoint that hosts the LAG.
Type: String
- awsLogicalDeviceId
-
The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.
Type: String
- connections
-
The connections bundled by the LAG.
Type: Array of Connection objects
- connectionsBandwidth
-
The individual bandwidth of the physical connections bundled by the LAG. The possible values are 1Gbps, 10Gbps, 100Gbps, or 400 Gbps..
Type: String
- encryptionMode
-
The LAG MAC Security (MACsec) encryption mode.
The valid values are
no_encrypt,should_encrypt, andmust_encrypt.Type: String
- hasLogicalRedundancy
-
Indicates whether the LAG supports a secondary BGP peer in the same address family (IPv4/IPv6).
Type: String
Valid Values:
unknown | yes | no - jumboFrameCapable
-
Indicates whether jumbo frames are supported.
Type: Boolean
- lagId
-
The ID of the LAG.
Type: String
- lagName
-
The name of the LAG.
Type: String
- 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.
Type: String
Valid Values:
requested | pending | available | down | deleting | deleted | unknown -
- location
-
The location of the LAG.
Type: String
- macSecCapable
-
Indicates whether the LAG supports MAC Security (MACsec).
Type: Boolean
- macSecKeys
-
The MAC Security (MACsec) security keys associated with the LAG.
Type: Array of MacSecKey objects
- minimumLinks
-
The minimum number of physical dedicated connections that must be operational for the LAG itself to be operational.
Type: Integer
- numberOfConnections
-
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.
Type: Integer
- ownerAccount
-
The ID of the AWS account that owns the LAG.
Type: String
- providerName
-
The name of the service provider associated with the LAG.
Type: String
- region
-
The AWS Region where the connection is located.
Type: String
-
The tags associated with the LAG.
Type: Array of Tag objects
Array Members: Minimum number of 1 item.
Errors
For information about the errors that are common to all actions, see Common Errors.
- DirectConnectClientException
-
One or more parameters are not valid.
HTTP Status Code: 400
- DirectConnectServerException
-
A server-side error occurred.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
