v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1485367296.2 KB

Associates a customer gateway with a device and optionally, with a link. If you specify a link, it must be associated with the specified device.

You can only associate customer gateways that are connected to a VPN attachment on a transit gateway or core network registered in your global network. When you register a transit gateway or core network, customer gateways that are connected to the transit gateway are automatically included in the global network. To list customer gateways that are connected to a transit gateway, use the DescribeVpnConnections EC2 API and filter by transit-gateway-id.

You cannot associate a customer gateway with more than one device and link.

post/global-networks/{globalNetworkId}/customer-gateway-associations

Path parameters

globalNetworkIdstring required

The ID of the global network.

Request body

CustomerGatewayArnstring required

The Amazon Resource Name (ARN) of the customer gateway.

DeviceIdstring required

The ID of the device.

LinkIdstring

The ID of the link.

Response

Success