Class UpdateLagCommandProtected

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.

  Amazon Web Services assigns this value to each connection which is part of the LAG.

• The tags

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.

Example

Use a bare-bones client and the command you need to make an API call.

import { DirectConnectClient, UpdateLagCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, UpdateLagCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // UpdateLagRequest
  lagId: "STRING_VALUE", // required
  lagName: "STRING_VALUE",
  minimumLinks: Number("int"),
  encryptionMode: "STRING_VALUE",
};
const command = new UpdateLagCommand(input);
const response = await client.send(command);
// { // Lag
//   connectionsBandwidth: "STRING_VALUE",
//   numberOfConnections: Number("int"),
//   lagId: "STRING_VALUE",
//   ownerAccount: "STRING_VALUE",
//   lagName: "STRING_VALUE",
//   lagState: "requested" || "pending" || "available" || "down" || "deleting" || "deleted" || "unknown",
//   location: "STRING_VALUE",
//   region: "STRING_VALUE",
//   minimumLinks: Number("int"),
//   awsDevice: "STRING_VALUE",
//   awsDeviceV2: "STRING_VALUE",
//   awsLogicalDeviceId: "STRING_VALUE",
//   connections: [ // ConnectionList
//     { // Connection
//       ownerAccount: "STRING_VALUE",
//       connectionId: "STRING_VALUE",
//       connectionName: "STRING_VALUE",
//       connectionState: "ordering" || "requested" || "pending" || "available" || "down" || "deleting" || "deleted" || "rejected" || "unknown",
//       region: "STRING_VALUE",
//       location: "STRING_VALUE",
//       bandwidth: "STRING_VALUE",
//       vlan: Number("int"),
//       partnerName: "STRING_VALUE",
//       loaIssueTime: new Date("TIMESTAMP"),
//       lagId: "STRING_VALUE",
//       awsDevice: "STRING_VALUE",
//       jumboFrameCapable: true || false,
//       awsDeviceV2: "STRING_VALUE",
//       awsLogicalDeviceId: "STRING_VALUE",
//       hasLogicalRedundancy: "unknown" || "yes" || "no",
//       tags: [ // TagList
//         { // Tag
//           key: "STRING_VALUE", // required
//           value: "STRING_VALUE",
//         },
//       ],
//       providerName: "STRING_VALUE",
//       macSecCapable: true || false,
//       portEncryptionStatus: "STRING_VALUE",
//       encryptionMode: "STRING_VALUE",
//       macSecKeys: [ // MacSecKeyList
//         { // MacSecKey
//           secretARN: "STRING_VALUE",
//           ckn: "STRING_VALUE",
//           state: "STRING_VALUE",
//           startOn: "STRING_VALUE",
//         },
//       ],
//     },
//   ],
//   allowsHostedConnections: true || false,
//   jumboFrameCapable: true || false,
//   hasLogicalRedundancy: "unknown" || "yes" || "no",
//   tags: [
//     {
//       key: "STRING_VALUE", // required
//       value: "STRING_VALUE",
//     },
//   ],
//   providerName: "STRING_VALUE",
//   macSecCapable: true || false,
//   encryptionMode: "STRING_VALUE",
//   macSecKeys: [
//     {
//       secretARN: "STRING_VALUE",
//       ckn: "STRING_VALUE",
//       state: "STRING_VALUE",
//       startOn: "STRING_VALUE",
//     },
//   ],
// };

Param

UpdateLagCommandInput

Returns

UpdateLagCommandOutput

See

• UpdateLagCommandInput for command's input shape.
• UpdateLagCommandOutput for command's response shape.
• config for DirectConnectClient's config shape.

Throws

DirectConnectClientException (client fault)

One or more parameters are not valid.

Throws

DirectConnectServerException (server fault)

A server-side error occurred.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.