describe-direct-connect-gateway-association-proposals¶

Description¶

Describes one or more association proposals for connection between a virtual private gateway or transit gateway and a Direct Connect gateway.

Synopsis¶

  describe-direct-connect-gateway-association-proposals
[--direct-connect-gateway-id <value>]
[--proposal-id <value>]
[--associated-gateway-id <value>]
[--max-results <value>]
[--next-token <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

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

The ID of the Direct Connect gateway.

--proposal-id (string)

The ID of the proposal.

--associated-gateway-id (string)

The ID of the associated gateway.

--max-results (integer)

The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

If MaxResults is given a value larger than 100, only 100 results are returned.

--next-token (string)

The token for the next page of results.

--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 describe your Direct Connect gateway association proposals

The following describe-direct-connect-gateway-association-proposals example displays details about your Direct Connect gateway association proposals.

aws directconnect describe-direct-connect-gateway-association-proposals

Output:

{
    "directConnectGatewayAssociationProposals": [
        {
            "proposalId": "c2ede9b4-bbc6-4d33-923c-bc4feEXAMPLE",
            "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
            "directConnectGatewayOwnerAccount": "111122223333",
            "proposalState": "requested",
            "associatedGateway": {
                "id": "tgw-02f776b1a7EXAMPLE",
                "type": "transitGateway",
                "ownerAccount": "111122223333",
                "region": "us-east-1"
            },
            "existingAllowedPrefixesToDirectConnectGateway": [
                {
                    "cidr": "192.168.2.0/30"
                },
                {
                    "cidr": "192.168.1.0/30"
                }
            ],
            "requestedAllowedPrefixesToDirectConnectGateway": [
                {
                    "cidr": "192.168.1.0/30"
                }
            ]
        },
        {
            "proposalId": "cb7f41cb-8128-43a5-93b1-dcaedEXAMPLE",
            "directConnectGatewayId": "11560968-4ac1-4fd3-bcb2-00599EXAMPLE",
            "directConnectGatewayOwnerAccount": "111122223333",
            "proposalState": "accepted",
            "associatedGateway": {
                "id": "tgw-045776b1a7EXAMPLE",
                "type": "transitGateway",
                "ownerAccount": "111122223333",
                "region": "us-east-1"
            },
            "existingAllowedPrefixesToDirectConnectGateway": [
                {
                    "cidr": "192.168.4.0/30"
                },
                {
                    "cidr": "192.168.5.0/30"
                }
            ],
            "requestedAllowedPrefixesToDirectConnectGateway": [
                {
                    "cidr": "192.168.5.0/30"
                }
            ]
        }
    ]
}

For more information, see Associating and Disassociating Transit Gateways in the AWS Direct Connect User Guide.

Output¶

directConnectGatewayAssociationProposals -> (list)

Describes the Direct Connect gateway association proposals.

(structure)

Information about the proposal request to attach a virtual private gateway to a Direct Connect gateway.

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.

nextToken -> (string)

The token to use to retrieve the next page of results. This value is null when there are no more results to return.

Table of Contents

Feedback

User Guide