AssociateCustomerGateway
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.
Request Syntax
POST /global-networks/globalNetworkId/customer-gateway-associations HTTP/1.1
Content-type: application/json
{
"CustomerGatewayArn": "string",
"DeviceId": "string",
"LinkId": "string"
}URI Request Parameters
The request uses the following URI parameters.
- globalNetworkId
-
The ID of the global network.
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[\s\S]*Required: Yes
Request Body
The request accepts the following data in JSON format.
- CustomerGatewayArn
-
The Amazon Resource Name (ARN) of the customer gateway.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 500.
Pattern:
[\s\S]*Required: Yes
- DeviceId
-
The ID of the device.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[\s\S]*Required: Yes
- LinkId
-
The ID of the link.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 50.
Pattern:
[\s\S]*Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"CustomerGatewayAssociation": {
"CustomerGatewayArn": "string",
"DeviceId": "string",
"GlobalNetworkId": "string",
"LinkId": "string",
"State": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- CustomerGatewayAssociation
-
The customer gateway association.
Type: CustomerGatewayAssociation object
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
There was a conflict processing the request. Updating or deleting the resource can cause an inconsistent state.
HTTP Status Code: 409
- InternalServerException
-
The request has failed due to an internal error.
HTTP Status Code: 500
- ResourceNotFoundException
-
The specified resource could not be found.
HTTP Status Code: 404
- ServiceQuotaExceededException
-
A service limit was exceeded.
HTTP Status Code: 402
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
