Class AllocateTransitVirtualInterfaceCommandProtected

Provisions a transit virtual interface to be owned by the specified Amazon Web Services account. Use this type of interface to connect a transit gateway to your Direct Connect gateway.

The owner of a connection provisions a transit virtual interface to be owned by the specified Amazon Web Services account.

After you create a transit virtual interface, it must be confirmed by the owner using ConfirmTransitVirtualInterface. Until this step has been completed, the transit virtual interface is in the requested state and is not available to handle traffic.

Example

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

import { DirectConnectClient, AllocateTransitVirtualInterfaceCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, AllocateTransitVirtualInterfaceCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // AllocateTransitVirtualInterfaceRequest
  connectionId: "STRING_VALUE", // required
  ownerAccount: "STRING_VALUE", // required
  newTransitVirtualInterfaceAllocation: { // NewTransitVirtualInterfaceAllocation
    virtualInterfaceName: "STRING_VALUE",
    vlan: Number("int"),
    asn: Number("int"),
    mtu: Number("int"),
    authKey: "STRING_VALUE",
    amazonAddress: "STRING_VALUE",
    customerAddress: "STRING_VALUE",
    addressFamily: "ipv4" || "ipv6",
    tags: [ // TagList
      { // Tag
        key: "STRING_VALUE", // required
        value: "STRING_VALUE",
      },
    ],
  },
};
const command = new AllocateTransitVirtualInterfaceCommand(input);
const response = await client.send(command);
// { // AllocateTransitVirtualInterfaceResult
//   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

AllocateTransitVirtualInterfaceCommandInput

Returns

AllocateTransitVirtualInterfaceCommandOutput

See

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