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

CreateInterconnect

Creates an interconnect between an 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 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 partner's network to an AWS Direct Connect location over a standard 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 is 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 partner.

Note

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, in Gbps. The possible values are 1 and 10.

Type: String

Required: Yes

interconnectName

The name of the interconnect.

Type: String

Required: Yes

lagId

The ID of the LAG.

Type: String

Required: No

location

The location of the interconnect.

Type: String

Required: Yes

Response Syntax

{ "awsDevice": "string", "awsDeviceV2": "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

[Deprecated. Use awsDeviceV2 instead] The Direct Connect endpoint on which the physical connection terminates.

Type: String

awsDeviceV2

The Direct Connect endpoint on which the physical connection terminates.

Type: String

bandwidth

The bandwidth of the connection.

Type: String

interconnectId

The ID of the interconnect.

Type: String

interconnectName

The name of the interconnect.

Type: String

interconnectState

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

  • 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 is 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 being deleted.

  • deleted: The interconnect is deleted.

Type: String

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

lagId

The ID of the LAG.

Type: String

loaIssueTime

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

Type: Timestamp

location

The location of the connection.

Type: String

region

The AWS Region where the connection is located.

Type: String

Errors

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

DirectConnectClientException

One or more parameters are not valid.

HTTP Status Code: 400

DirectConnectServerException

A server-side error occurred.

HTTP Status Code: 400

See Also

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