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-association

Description

Creates an association between a direct connect gateway and a virtual private gateway (VGW). The VGW must be attached to a VPC and must not be associated with another direct connect gateway.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  create-direct-connect-gateway-association
--direct-connect-gateway-id <value>
--virtual-gateway-id <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--direct-connect-gateway-id (string)

The ID of the direct connect gateway.

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

Default: None

--virtual-gateway-id (string)

The ID of the virtual private gateway.

Example: "vgw-abc123ef"

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 associate a virtual private gateway with a Direct Connect gateway

The following example associates virtual private gateway vgw-6efe725e with Direct Connect gateway 5f294f92-bafb-4011-916d-9b0bexample. You must run the command in the region in which the virtual private gateway is located.

Command:

aws directconnect create-direct-connect-gateway-association --direct-connect-gateway-id 5f294f92-bafb-4011-916d-9b0bexample --virtual-gateway-id vgw-6efe725e

Output:

{
  "directConnectGatewayAssociation": {
      "associationState": "associating",
      "virtualGatewayOwnerAccount": "123456789012",
      "directConnectGatewayId": "5f294f92-bafb-4011-916d-9b0bexample",
      "virtualGatewayId": "vgw-6efe725e",
      "virtualGatewayRegion": "us-east-2"
  }
}

Output

directConnectGatewayAssociation -> (structure)

The direct connect gateway association to be created.

directConnectGatewayId -> (string)

The ID of the direct connect gateway.

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

virtualGatewayId -> (string)

The ID of the virtual private gateway to a VPC. This only applies to private virtual interfaces.

Example: vgw-123er56

virtualGatewayRegion -> (string)

The region in which the virtual private gateway is located.

Example: us-east-1

virtualGatewayOwnerAccount -> (string)

The AWS account ID of the owner of the virtual private gateway.

associationState -> (string)

State of the direct connect gateway association.

  • Associating : The initial state after calling create-direct-connect-gateway-association .
  • Associated : The direct connect gateway and virtual private gateway are successfully associated and ready to pass traffic.
  • Disassociating : The initial state after calling delete-direct-connect-gateway-association .
  • Disassociated : The virtual private gateway is successfully disassociated from the direct connect gateway. Traffic flow between the direct connect gateway and virtual private gateway stops.

stateChangeError -> (string)

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