AWS Direct Connect

Use the generic connection Create, Read, Update and Delete (CRUD) routes for searching, updating and deleting Layer 2 AWS Direct Connect Partner connections.

Create a Layer 2 AWS Direct Connect Partner connection

Prerequisites

  • Your company has been verified on the Console Connect platform.

  • The authenticated user account has Network Admin permissions.

  • The source port is ACTIVE.

  • You are requesting paymentType "invoice", or, if requesting paymentType "plan", the subscription associated with the port has sufficient entitlement to complete the request.

Securityapi-key
Request
path Parameters
companyUsername
required
string

The username of the company creating the connection.

Example: acme
Request Body schema: application/json
required
name
required
string

The name of the AWS Cloud.

srcPortId
required
string

The portId of the port from your company that you want to connect from.

destPortId
required
string

The AWS destination port ID.

speed
required
integer

The speed of the connection in Mbps.

required
object
type
required
string

Type of connection.

Value: "LAYER2"
duration
required
integer

The duration of the connection.

durationUnit
required
string

The unit of duration.

Enum: "y" "m"
classOfService
string

The class of service of the connection.

Value: "SILVER"
paymentType
required
string

The payment method used.

Value: "invoice"
evergreen
boolean

Set to true if you choose to have your connection and payment continue on a month to month basis at the end of your selected duration, else set to false.

discountCode
string
Responses
200

OK

put/api/company/{companyUsername}/connections/directConnectPartner/AWS/layer2
Request samples
application/json
{
  • "name": "amazon",
  • "srcPortId": "5de6f8601693740b2c852398",
  • "destPortId": "5de6f85d1693740b2c852394",
  • "speed": 100,
  • "partner": {
    },
  • "type": "LAYER2",
  • "duration": 1,
  • "durationUnit": "y",
  • "paymentType": "invoice",
  • "evergreen": true
}