AllocateConnectionOnInterconnectCommand

Suggest an Edit

Deprecated. Use AllocateHostedConnection instead.

Creates a hosted connection on an interconnect.

Allocates a VLAN number and a specified amount of bandwidth for use by a hosted connection on the specified interconnect.

Intended for use by Direct Connect Partners only.

Example Syntax

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

import { DirectConnectClient, AllocateConnectionOnInterconnectCommand } from "@aws-sdk/client-direct-connect"; // ES Modules import
// const { DirectConnectClient, AllocateConnectionOnInterconnectCommand } = require("@aws-sdk/client-direct-connect"); // CommonJS import
const client = new DirectConnectClient(config);
const input = { // AllocateConnectionOnInterconnectRequest
  bandwidth: "STRING_VALUE", // required
  connectionName: "STRING_VALUE", // required
  ownerAccount: "STRING_VALUE", // required
  interconnectId: "STRING_VALUE", // required
  vlan: Number("int"), // required
};
const command = new AllocateConnectionOnInterconnectCommand(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",
//     },
//   ],
// };

AllocateConnectionOnInterconnectCommand Input

See AllocateConnectionOnInterconnectCommandInput for more details

Parameter
Type
Description
bandwidth
Required
string | undefined

The bandwidth of the connection. The possible values are 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, 500Mbps, 1Gbps, 2Gbps, 5Gbps, and 10Gbps. Note that only those Direct Connect Partners who have met specific requirements are allowed to create a 1Gbps, 2Gbps, 5Gbps or 10Gbps hosted connection.

connectionName
Required
string | undefined

The name of the provisioned connection.

interconnectId
Required
string | undefined

The ID of the interconnect on which the connection will be provisioned.

ownerAccount
Required
string | undefined

The ID of the Amazon Web Services account of the customer for whom the connection will be provisioned.

vlan
Required
number | undefined

The dedicated VLAN provisioned to the connection.

AllocateConnectionOnInterconnectCommand Output

See AllocateConnectionOnInterconnectCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
awsDevice
string | undefined

The Direct Connect endpoint on which the physical connection terminates.

awsDeviceV2
string | undefined

The Direct Connect endpoint that terminates the physical connection.

awsLogicalDeviceId
string | undefined

The Direct Connect endpoint that terminates the logical connection. This device might be different than the device that terminates the physical connection.

bandwidth
string | undefined

The bandwidth of the connection.

connectionId
string | undefined

The ID of the connection.

connectionName
string | undefined

The name of the connection.

connectionState
ConnectionState | undefined

The state of the connection. The following are the possible values:

  • ordering: The initial state of a hosted connection provisioned on an interconnect. The connection stays in the ordering state until the owner of the hosted connection confirms or declines the connection order.

  • requested: The initial state of a standard connection. The connection stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • pending: The connection has been approved and is being initialized.

  • available: The network link is up and the connection is ready for use.

  • down: The network link is down.

  • deleting: The connection is being deleted.

  • deleted: The connection has been deleted.

  • rejected: A hosted connection in the ordering state enters the rejected state if it is deleted by the customer.

  • unknown: The state of the connection is not available.

encryptionMode
string | undefined

The MAC Security (MACsec) connection encryption mode.

The valid values are no_encrypt, should_encrypt, and must_encrypt.

hasLogicalRedundancy
HasLogicalRedundancy | undefined

Indicates whether the connection supports a secondary BGP peer in the same address family (IPv4/IPv6).

jumboFrameCapable
boolean | undefined

Indicates whether jumbo frames are supported.

lagId
string | undefined

The ID of the LAG.

loaIssueTime
Date | undefined

The time of the most recent call to DescribeLoa for this connection.

location
string | undefined

The location of the connection.

macSecCapable
boolean | undefined

Indicates whether the connection supports MAC Security (MACsec).

macSecKeys
MacSecKey[] | undefined

The MAC Security (MACsec) security keys associated with the connection.

ownerAccount
string | undefined

The ID of the Amazon Web Services account that owns the connection.

partnerName
string | undefined

The name of the Direct Connect service provider associated with the connection.

portEncryptionStatus
string | undefined

The MAC Security (MACsec) port link status of the connection.

The valid values are Encryption Up, which means that there is an active Connection Key Name, or Encryption Down.

providerName
string | undefined

The name of the service provider associated with the connection.

region
string | undefined

The Amazon Web Services Region where the connection is located.

tags
Tag[] | undefined

The tags associated with the connection.

vlan
number | undefined

The ID of the VLAN.

Throws

Name
Fault
Details
DirectConnectClientException
client

One or more parameters are not valid.

DirectConnectServerException
server

A server-side error occurred.

DirectConnectServiceException
Base exception class for all service exceptions from DirectConnect service.