[ aws . directconnect ]
Updates the specified attributes of the Direct Connect gateway association.
Add or remove prefixes from the association.
See also: AWS API Documentation
See ‘aws help’ for descriptions of global parameters.
update-direct-connect-gateway-association
[--association-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>]
--association-id
(string)
The ID of the Direct Connect gateway association.
--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.
To update the specified attributes of the Direct Connect gateway association
The following update-direct-connect-gateway-association
example adds the specified CIDR block to a Direct Connect gateway association.
aws directconnect update-direct-connect-gateway-association \
--association-id 820a6e4f-5374-4004-8317-3f64bEXAMPLE \
--add-allowed-prefixes-to-direct-connect-gateway cidr=192.168.2.0/30
Output:
{
"directConnectGatewayAssociation": {
"directConnectGatewayId": "11460968-4ac1-4fd3-bdb2-00599EXAMPLE",
"directConnectGatewayOwnerAccount": "111122223333",
"associationState": "updating",
"associatedGateway": {
"id": "tgw-02f776b1a7EXAMPLE",
"type": "transitGateway",
"ownerAccount": "111122223333",
"region": "us-east-1"
},
"associationId": "820a6e4f-5374-4004-8317-3f64bEXAMPLE",
"allowedPrefixesToDirectConnectGateway": [
{
"cidr": "192.168.2.0/30"
},
{
"cidr": "192.168.1.0/30"
}
]
}
}
For more information, see Working with Direct Connect Gateways in the AWS Direct Connect User Guide.
directConnectGatewayAssociation -> (structure)
Information about an association between a Direct Connect gateway and a virtual private gateway or transit gateway.
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.