Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . directconnect ]

allocate-connection-on-interconnect

Description

Deprecated in favor of allocate-hosted-connection .

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 given interconnect.

Note

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

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  allocate-connection-on-interconnect
--bandwidth <value>
--connection-name <value>
--owner-account <value>
--interconnect-id <value>
--vlan <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--bandwidth (string)

bandwidth of the connection.

Example: "500Mbps "

Default: None

Values: 50Mbps, 100Mbps, 200Mbps, 300Mbps, 400Mbps, or 500Mbps

--connection-name (string)

Name of the provisioned connection.

Example: "500M Connection to AWS "

Default: None

--owner-account (string)

Numeric account Id of the customer for whom the connection will be provisioned.

Example: 123443215678

Default: None

--interconnect-id (string)

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

Example: dxcon-456abc78

Default: None

--vlan (integer)

The dedicated vlan provisioned to the connection.

Example: 101

Default: None

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Examples

To create a hosted connection on an interconnect

The following allocate-connection-on-interconnect command creates a hosted connection on an interconnect:

aws directconnect allocate-connection-on-interconnect --bandwidth 500Mbps --connection-name mydcinterconnect --owner-account 123456789012 --interconnect-id dxcon-fgktov66 --vlan 101

Output:

{
    "partnerName": "TIVIT",
    "vlan": 101,
    "ownerAccount": "123456789012",
    "connectionId": "dxcon-ffzc51m1",
    "connectionState": "ordering",
    "bandwidth": "500Mbps",
    "location": "TIVIT",
    "connectionName": "mydcinterconnect",
    "region": "sa-east-1"
}

Output

ownerAccount -> (string)

The AWS account that will own the new connection.

connectionId -> (string)

The ID of the connection. This field is also used as the ID type for operations that use multiple connection types (LAG, interconnect, and/or connection).

Example: dxcon-fg5678gh

Default: None

connectionName -> (string)

The name of the connection.

Example: "My Connection to AWS "

Default: None

connectionState -> (string)

State of the connection.

  • 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 in the process of being deleted.
  • Deleted : The connection has been deleted.
  • Rejected : A hosted connection in the 'Ordering' state will enter the 'Rejected' state if it is deleted by the end customer.

region -> (string)

The AWS region where the connection is located.

Example: us-east-1

Default: None

location -> (string)

Where the connection is located.

Example: EqSV5

Default: None

bandwidth -> (string)

bandwidth of the connection.

Example: 1Gbps (for regular connections), or 500Mbps (for hosted connections)

Default: None

vlan -> (integer)

The vlan ID.

Example: 101

partnerName -> (string)

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

loaIssueTime -> (timestamp)

The time of the most recent call to describe-loa for this connection.

lagId -> (string)

The ID of the LAG.

Example: dxlag-fg5678gh

awsDevice -> (string)

The Direct Connection endpoint which the physical connection terminates on.