[ aws . directconnect ]

create-direct-connect-gateway-association

Description

Creates an association between a Direct Connect gateway and a virtual private gateway. The virtual private gateway 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>
[--gateway-id <value>]
[--add-allowed-prefixes-to-direct-connect-gateway <value>]
[--virtual-gateway-id <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

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

The ID of the Direct Connect gateway.

--gateway-id (string)

The ID of the virtual private gateway or transit gateway.

--add-allowed-prefixes-to-direct-connect-gateway (list)

The Amazon VPC prefixes to advertise to the Direct Connect gateway

This parameter is required when you create an association to a transit gateway.

For information about how to set the prefixes, see Allowed Prefixes in the AWS Direct Connect User Guide .

(structure)

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

cidr -> (string)

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

Shorthand Syntax:

cidr=string ...

JSON Syntax:

[
  {
    "cidr": "string"
  }
  ...
]

--virtual-gateway-id (string)

The ID of the virtual private gateway.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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 association to be created.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount -> (string)

The ID of the AWS account that owns the associated gateway.

associationState -> (string)

The state of the association. The following are the possible values:

• associating : The initial state after calling CreateDirectConnectGatewayAssociation .

• associated : The Direct Connect gateway and virtual private gateway or transit gateway are successfully associated and ready to pass traffic.

• disassociating : The initial state after calling DeleteDirectConnectGatewayAssociation .

• disassociated : The virtual private gateway or transit gateway is disassociated from the Direct Connect gateway. Traffic flow between the Direct Connect gateway and virtual private gateway or transit gateway is stopped.

stateChangeError -> (string)

The error message if the state of an object failed to advance.

associatedGateway -> (structure)

Information about the associated gateway.

id -> (string)

The ID of the associated gateway.

type -> (string)

The type of associated gateway.

ownerAccount -> (string)

The ID of the AWS account that owns the associated virtual private gateway or transit gateway.

region -> (string)

The Region where the associated gateway is located.

associationId -> (string)

The ID of the Direct Connect gateway association.

allowedPrefixesToDirectConnectGateway -> (list)

The Amazon VPC prefixes to advertise to the Direct Connect gateway.

(structure)

Information about a route filter prefix that a customer can advertise through Border Gateway Protocol (BGP) over a public virtual interface.

cidr -> (string)

The CIDR block for the advertised route. Separate multiple routes using commas. An IPv6 CIDR must use /64 or shorter.

virtualGatewayId -> (string)

The ID of the virtual private gateway. Applies only to private virtual interfaces.

virtualGatewayRegion -> (string)

The AWS Region where the virtual private gateway is located.

virtualGatewayOwnerAccount -> (string)

The ID of the AWS account that owns the virtual private gateway.