Menu
AWS Direct Connect
API Reference (API Version 2012-10-25)

CreateInterconnect

Creates a new interconnect between a AWS Direct Connect partner's network and a specific AWS Direct Connect location.

An interconnect is a connection which is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide sub-1Gbps AWS Direct Connect service to tier 2 customers who do not have their own connections. Like a standard connection, an interconnect links the AWS Direct Connect partner's network to an AWS Direct Connect location over a standard 1 Gbps or 10 Gbps Ethernet fiber-optic cable. One end is connected to the partner's router, the other to an AWS Direct Connect router.

You can automatically add the new interconnect to a link aggregation group (LAG) by specifying a LAG ID in the request. This ensures that the new interconnect is allocated on the same AWS Direct Connect endpoint that hosts the specified LAG. If there are no available ports on the endpoint, the request fails and no interconnect will be created.

For each end customer, the AWS Direct Connect partner provisions a connection on their interconnect by calling AllocateConnectionOnInterconnect. The end customer can then connect to AWS resources by creating a virtual interface on their connection, using the VLAN assigned to them by the AWS Direct Connect partner.

Note

This is intended for use by AWS Direct Connect partners only.

Request Syntax

{
   "bandwidth": "string",
   "interconnectName": "string",
   "lagId": "string",
   "location": "string"
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

bandwidth

The port bandwidth

Example: 1Gbps

Default: None

Available values: 1Gbps,10Gbps

Type: String

Required: Yes

interconnectName

The name of the interconnect.

Example: "1G Interconnect to AWS"

Default: None

Type: String

Required: Yes

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

Required: No

location

Where the interconnect is located

Example: EqSV5

Default: None

Type: String

Required: Yes

Response Syntax

{
   "awsDevice": "string",
   "bandwidth": "string",
   "interconnectId": "string",
   "interconnectName": "string",
   "interconnectState": "string",
   "lagId": "string",
   "loaIssueTime": number,
   "location": "string",
   "region": "string"
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

awsDevice

The Direct Connection endpoint which the physical connection terminates on.

Type: String

bandwidth

Bandwidth of the connection.

Example: 1Gbps

Default: None

Type: String

interconnectId

The ID of the interconnect.

Example: dxcon-abc123

Type: String

interconnectName

The name of the interconnect.

Example: "1G Interconnect to AWS"

Type: String

interconnectState

State of the interconnect.

  • Requested: The initial state of an interconnect. The interconnect stays in the requested state until the Letter of Authorization (LOA) is sent to the customer.

  • Pending: The interconnect has been approved, and is being initialized.

  • Available: The network link is up, and the interconnect is ready for use.

  • Down: The network link is down.

  • Deleting: The interconnect is in the process of being deleted.

  • Deleted: The interconnect has been deleted.

Type: String

Valid Values: requested | pending | available | down | deleting | deleted

lagId

The ID of the LAG.

Example: dxlag-fg5678gh

Type: String

loaIssueTime

The time of the most recent call to DescribeInterconnectLoa for this Interconnect.

Type: Timestamp

location

Where the connection is located.

Example: EqSV5

Default: None

Type: String

region

The AWS region where the connection is located.

Example: us-east-1

Default: None

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DirectConnectClientException

The API was called with invalid parameters. The error message will contain additional details about the cause.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred during the API call. The error message will contain additional details about the cause.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: