Class UpdateVirtualInterfaceAttributesCommandProtected

Updates the specified attributes of the specified virtual private interface.

Setting the MTU of a virtual interface to 9001 (jumbo frames) can cause an update to the underlying physical connection if it wasn't updated to support jumbo frames. Updating the connection disrupts network connectivity for all virtual interfaces associated with the connection for up to 30 seconds. To check whether your connection supports jumbo frames, call DescribeConnections. To check whether your virtual interface supports jumbo frames, call DescribeVirtualInterfaces.

Example

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

import { DirectConnectClient, UpdateVirtualInterfaceAttributesCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, UpdateVirtualInterfaceAttributesCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // UpdateVirtualInterfaceAttributesRequest
  virtualInterfaceId: "STRING_VALUE", // required
  mtu: Number("int"),
  enableSiteLink: true || false,
  virtualInterfaceName: "STRING_VALUE",
};
const command = new UpdateVirtualInterfaceAttributesCommand(input);
const response = await client.send(command);
// { // VirtualInterface
//   ownerAccount: "STRING_VALUE",
//   virtualInterfaceId: "STRING_VALUE",
//   location: "STRING_VALUE",
//   connectionId: "STRING_VALUE",
//   virtualInterfaceType: "STRING_VALUE",
//   virtualInterfaceName: "STRING_VALUE",
//   vlan: Number("int"),
//   asn: Number("int"),
//   amazonSideAsn: Number("long"),
//   authKey: "STRING_VALUE",
//   amazonAddress: "STRING_VALUE",
//   customerAddress: "STRING_VALUE",
//   addressFamily: "ipv4" || "ipv6",
//   virtualInterfaceState: "confirming" || "verifying" || "pending" || "available" || "down" || "deleting" || "deleted" || "rejected" || "unknown",
//   customerRouterConfig: "STRING_VALUE",
//   mtu: Number("int"),
//   jumboFrameCapable: true || false,
//   virtualGatewayId: "STRING_VALUE",
//   directConnectGatewayId: "STRING_VALUE",
//   routeFilterPrefixes: [ // RouteFilterPrefixList
//     { // RouteFilterPrefix
//       cidr: "STRING_VALUE",
//     },
//   ],
//   bgpPeers: [ // BGPPeerList
//     { // BGPPeer
//       bgpPeerId: "STRING_VALUE",
//       asn: Number("int"),
//       authKey: "STRING_VALUE",
//       addressFamily: "ipv4" || "ipv6",
//       amazonAddress: "STRING_VALUE",
//       customerAddress: "STRING_VALUE",
//       bgpPeerState: "verifying" || "pending" || "available" || "deleting" || "deleted",
//       bgpStatus: "up" || "down" || "unknown",
//       awsDeviceV2: "STRING_VALUE",
//       awsLogicalDeviceId: "STRING_VALUE",
//     },
//   ],
//   region: "STRING_VALUE",
//   awsDeviceV2: "STRING_VALUE",
//   awsLogicalDeviceId: "STRING_VALUE",
//   tags: [ // TagList
//     { // Tag
//       key: "STRING_VALUE", // required
//       value: "STRING_VALUE",
//     },
//   ],
//   siteLinkEnabled: true || false,
// };

Param

UpdateVirtualInterfaceAttributesCommandInput

Returns

UpdateVirtualInterfaceAttributesCommandOutput

See

• UpdateVirtualInterfaceAttributesCommandInput for command's input shape.
• UpdateVirtualInterfaceAttributesCommandOutput 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.