create-direct-connect-gateway-association-proposal¶

Description¶

Creates a proposal to associate the specified virtual private gateway or transit gateway with the specified Direct Connect gateway.

You can associate a Direct Connect gateway and virtual private gateway or transit gateway that is owned by any AWS account.

Synopsis¶

  create-direct-connect-gateway-association-proposal
--direct-connect-gateway-id <value>
--direct-connect-gateway-owner-account <value>
--gateway-id <value>
[--add-allowed-prefixes-to-direct-connect-gateway <value>]
[--remove-allowed-prefixes-to-direct-connect-gateway <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

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

The ID of the Direct Connect gateway.

--direct-connect-gateway-owner-account (string)

The ID of the AWS account that owns 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.

(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"
  }
  ...
]

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

The Amazon VPC prefixes to no longer 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.

Shorthand Syntax:

cidr=string ...

JSON Syntax:

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

--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 create a proposal to associate the specified transit gateway with the specified Direct Connect gateway

The following create-direct-connect-gateway-association-proposal example creates a proposal that associates the specified transit gateway with the specified Direct Connect gateway.

aws directconnect create-direct-connect-gateway-association-proposal \
    --direct-connect-gateway-id 11460968-4ac1-4fd3-bdb2-00599EXAMPLE \
    --direct-connect-gateway-owner-account 111122223333 \
    --gateway-id tgw-02f776b1a7EXAMPLE \
    --add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.1.0/30

Output:

{
    "directConnectGatewayAssociationProposal": {
        "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE",
        "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
        "directConnectGatewayOwnerAccount": "111122223333",
        "proposalState": "requested",
        "associatedGateway": {
            "id": "tgw-02f776b1a7EXAMPLE",
            "type": "transitGateway",
            "ownerAccount": "111122223333",
            "region": "us-east-1"
        },
        "requestedAllowedPrefixesToDirectConnectGateway": [
            {
                "cidr": "192.168.1.0/30"
            }
        ]
    }
}

For more information, see Creating a Transit Gateway Association Proposal in the AWS Direct Connect User Guide.

Output¶

directConnectGatewayAssociationProposal -> (structure)

Information about the Direct Connect gateway proposal.

proposalId -> (string)

The ID of the association proposal.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount -> (string)

The ID of the AWS account that owns the Direct Connect gateway.

proposalState -> (string)

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

accepted : The proposal has been accepted. The Direct Connect gateway association is available to use in this state.

deleted : The proposal has been deleted by the owner that made the proposal. The Direct Connect gateway association cannot be used in this state.

requested : The proposal has been requested. The Direct Connect gateway association cannot be used in this state.

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.

existingAllowedPrefixesToDirectConnectGateway -> (list)

The existing Amazon VPC prefixes advertised 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.

requestedAllowedPrefixesToDirectConnectGateway -> (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.

Table of Contents

Feedback

User Guide