delete-direct-connect-gateway-association¶

Description¶

Deletes the association between the specified Direct Connect gateway and virtual private gateway.

We recommend that you specify the associationID to delete the association. Alternatively, if you own virtual gateway and a Direct Connect gateway association, you can specify the virtualGatewayId and directConnectGatewayId to delete an association.

Synopsis¶

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

Options¶

--association-id (string)

The ID of the Direct Connect gateway association.

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

The ID of the Direct Connect gateway.

--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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Examples¶

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To delete a Direct Connect gateway association

The following delete-direct-connect-gateway-association example deletes the Direct Connect gateway association with a transit gateway that has the specified association ID.

aws directconnect delete-direct-connect-gateway-association --association-id  be85116d-46eb-4b43-a27a-da0c2ad648de

Output:

{
    "directConnectGatewayAssociation": {
        "directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPlE",
        "directConnectGatewayOwnerAccount": "123456789012",
        "associationState": "disassociating",
        "associatedGateway": {
            "id": "tgw-095b3b0b54EXAMPLE",
            "type": "transitGateway",
            "ownerAccount": "123456789012",
            "region": "us-east-1"
       },
        "associationId": " be85116d-46eb-4b43-a27a-da0c2ad648deEXAMPLE ",
        "allowedPrefixesToDirectConnectGateway": [
            {
                "cidr": "192.0.1.0/28"
            }
        ]
    }
}

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

Output¶

directConnectGatewayAssociation -> (structure)

Information about the deleted association.

directConnectGatewayId -> (string)

The ID of the Direct Connect gateway.

directConnectGatewayOwnerAccount -> (string)

The ID of the Amazon Web Services 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 Amazon Web Services 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 Amazon Web Services Region where the virtual private gateway is located.

virtualGatewayOwnerAccount -> (string)

The ID of the Amazon Web Services account that owns the virtual private gateway.

Table of Contents

Feedback

User Guide