Table Of Contents

Feedback

User Guide

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

[ aws . directconnect ]

create-direct-connect-gateway

Description

Creates a new direct connect gateway. A direct connect gateway is an intermediate object that enables you to connect a set of virtual interfaces and virtual private gateways. direct connect gateways are global and visible in any AWS region after they are created. The virtual interfaces and virtual private gateways that are connected through a direct connect gateway can be in different regions. This enables you to connect to a VPC in any region, regardless of the region in which the virtual interfaces are located, and pass traffic between them.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-direct-connect-gateway
--direct-connect-gateway-name <value>
[--amazon-side-asn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--direct-connect-gateway-name (string)

The name of the direct connect gateway.

Example: "My direct connect gateway"

Default: None

--amazon-side-asn (long)

The autonomous system number (ASN) for Border Gateway Protocol (BGP) to be configured on the Amazon side of the connection. The ASN must be in the private range of 64,512 to 65,534 or 4,200,000,000 to 4,294,967,294

Example: 65200

Default: 64512

--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 Direct Connect gateway

The following example creates a Direct Connect gateway with the name DxGateway1.

Command:

aws directconnect create-direct-connect-gateway --direct-connect-gateway-name "DxGateway1"

Output:

{
  "directConnectGateway": {
      "amazonSideAsn": 64512,
      "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bdexample",
      "ownerAccount": "123456789012",
      "directConnectGatewayName": "DxGateway1",
      "directConnectGatewayState": "available"
  }
}

Output

directConnectGateway -> (structure)

The direct connect gateway to be created.

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

Example: "abcd1234-dcba-5678-be23-cdef9876ab45"

directConnectGatewayName -> (string)

The name of the direct connect gateway.

Example: "My direct connect gateway"

Default: None

amazonSideAsn -> (long)

The autonomous system number (ASN) for the Amazon side of the connection.

ownerAccount -> (string)

The AWS account ID of the owner of the direct connect gateway.

directConnectGatewayState -> (string)

State of the direct connect gateway.

  • Pending : The initial state after calling create-direct-connect-gateway .
  • Available : The direct connect gateway is ready for use.
  • Deleting : The initial state after calling delete-direct-connect-gateway .
  • Deleted : The direct connect gateway is deleted and cannot pass traffic.

stateChangeError -> (string)

Error message when the state of an object fails to advance.