Class AllocateHostedConnectionCommandProtected

Creates a hosted connection on the specified interconnect or a link aggregation group (LAG) of interconnects.

Allocates a VLAN number and a specified amount of capacity (bandwidth) for use by a hosted connection on the specified interconnect or LAG of interconnects. Amazon Web Services polices the hosted connection for the specified capacity and the Direct Connect Partner must also police the hosted connection for the specified capacity.

Intended for use by Direct Connect Partners only.

Example

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

import { DirectConnectClient, AllocateHostedConnectionCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, AllocateHostedConnectionCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // AllocateHostedConnectionRequest
  connectionId: "STRING_VALUE", // required
  ownerAccount: "STRING_VALUE", // required
  bandwidth: "STRING_VALUE", // required
  connectionName: "STRING_VALUE", // required
  vlan: Number("int"), // required
  tags: [ // TagList
    { // Tag
      key: "STRING_VALUE", // required
      value: "STRING_VALUE",
    },
  ],
};
const command = new AllocateHostedConnectionCommand(input);
const response = await client.send(command);
// { // 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",
//     },
//   ],
// };

Param

AllocateHostedConnectionCommandInput

Returns

AllocateHostedConnectionCommandOutput

See

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