Class CreateTransitVirtualInterfaceCommandProtected

Creates a transit virtual interface. A transit virtual interface should be used to access one or more transit gateways associated with Direct Connect gateways. A transit virtual interface enables the connection of multiple VPCs attached to a transit gateway to a Direct Connect gateway.

If you associate your transit gateway with one or more Direct Connect gateways, the Autonomous System Number (ASN) used by the transit gateway and the Direct Connect gateway must be different. For example, if you use the default ASN 64512 for both your the transit gateway and Direct Connect gateway, the association request fails.

A jumbo MTU value must be either 1500 or 8500. No other values will be accepted. Setting the MTU of a virtual interface to 8500 (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, CreateTransitVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, CreateTransitVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // CreateTransitVirtualInterfaceRequest
  connectionId: "STRING_VALUE", // required
  newTransitVirtualInterface: { // NewTransitVirtualInterface
    virtualInterfaceName: "STRING_VALUE",
    vlan: Number("int"),
    asn: Number("int"),
    mtu: Number("int"),
    authKey: "STRING_VALUE",
    amazonAddress: "STRING_VALUE",
    customerAddress: "STRING_VALUE",
    addressFamily: "ipv4" || "ipv6",
    directConnectGatewayId: "STRING_VALUE",
    tags: [ // TagList
      { // Tag
        key: "STRING_VALUE", // required
        value: "STRING_VALUE",
      },
    ],
    enableSiteLink: true || false,
  },
};
const command = new CreateTransitVirtualInterfaceCommand(input);
const response = await client.send(command);
// { // CreateTransitVirtualInterfaceResult
//   virtualInterface: { // 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

CreateTransitVirtualInterfaceCommandInput

Returns

CreateTransitVirtualInterfaceCommandOutput

See

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

DuplicateTagKeysException (client fault)

A tag key was specified more than once.

Throws

TooManyTagsException (client fault)

You have reached the limit on the number of tags that can be assigned.

Throws

DirectConnectServiceException

Base exception class for all service exceptions from DirectConnect service.