AddCustomRoutingEndpoints - AWS Global Accelerator

AddCustomRoutingEndpoints

Associate a virtual private cloud (VPC) subnet endpoint with your custom routing accelerator.

The listener port range must be large enough to support the number of IP addresses that can be specified in your subnet. The number of ports required is: subnet size times the number of ports per destination EC2 instances. For example, a subnet defined as /24 requires a listener port range of at least 255 ports.

Note: You must have enough remaining listener ports available to map to the subnet ports, or the call will fail with a LimitExceededException.

By default, all destinations in a subnet in a custom routing accelerator cannot receive traffic. To enable all destinations to receive traffic, or to specify individual port mappings that can receive traffic, see the AllowCustomRoutingTraffic operation.

Request Syntax

{ "EndpointConfigurations": [ { "EndpointId": "string" } ], "EndpointGroupArn": "string" }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

EndpointConfigurations

The list of endpoint objects to add to a custom routing accelerator.

Type: Array of CustomRoutingEndpointConfiguration objects

Array Members: Minimum number of 1 item. Maximum number of 20 items.

Required: Yes

EndpointGroupArn

The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax

{ "EndpointDescriptions": [ { "EndpointId": "string" } ], "EndpointGroupArn": "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.

EndpointDescriptions

The endpoint objects added to the custom routing accelerator.

Type: Array of CustomRoutingEndpointDescription objects

EndpointGroupArn

The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

Type: String

Length Constraints: Maximum length of 255.

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You don't have access permission.

HTTP Status Code: 400

ConflictException

You can't use both of those options.

HTTP Status Code: 400

EndpointAlreadyExistsException

The endpoint that you specified doesn't exist.

HTTP Status Code: 400

EndpointGroupNotFoundException

The endpoint group that you specified doesn't exist.

HTTP Status Code: 400

InternalServiceErrorException

There was an internal error for AWS Global Accelerator.

HTTP Status Code: 400

InvalidArgumentException

An argument that you specified is invalid.

HTTP Status Code: 400

LimitExceededException

Processing your request would cause you to exceed an AWS Global Accelerator limit.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: