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 that is capable of hosting other connections. The AWS Direct Connect partner can use an interconnect to provide AWS Direct Connect hosted connections to customers through their own network services. 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 AllocateHostedConnection. 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

Intended for use by AWS Direct Connect Partners only.

Request Syntax

{ "bandwidth": "string", "interconnectName": "string", "lagId": "string", "location": "string", "tags": [ { "key": "string", "value": "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

tags

The tags to assign to the interconnect,

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

Required: No

Response Syntax

{ "awsDevice": "string", "awsDeviceV2": "string", "bandwidth": "string", "hasLogicalRedundancy": "string", "interconnectId": "string", "interconnectName": "string", "interconnectState": "string", "jumboFrameCapable": boolean, "lagId": "string", "loaIssueTime": number, "location": "string", "region": "string", "tags": [ { "key": "string", "value": "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

This parameter has been deprecated.

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

hasLogicalRedundancy

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

Type: String

Valid Values: unknown | yes | no

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.

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

Type: String

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

jumboFrameCapable

Indicates whether jumbo frames (9001 MTU) are supported.

Type: Boolean

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

tags

Any tags assigned to the interconnect.

Type: Array of Tag objects

Array Members: Minimum number of 1 item.

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

DuplicateTagKeysException

A tag key was specified more than once.

HTTP Status Code: 400

TooManyTagsException

You have reached the limit on the number of tags that can be assigned.

HTTP Status Code: 400

See Also

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