GlobalAccelerator / Client / add_custom_routing_endpoints

add_custom_routing_endpoints#

GlobalAccelerator.Client.add_custom_routing_endpoints(**kwargs)#

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

response = client.add_custom_routing_endpoints(
    EndpointConfigurations=[
        {
            'EndpointId': 'string',
            'AttachmentArn': 'string'
        },
    ],
    EndpointGroupArn='string'
)

Parameters:

EndpointConfigurations (list) –
[REQUIRED]

The list of endpoint objects to add to a custom routing accelerator.
- (dict) –
  
  The list of endpoint objects. For custom routing, this is a list of virtual private cloud (VPC) subnet IDs.
  - EndpointId (string) –
    
    An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
  - AttachmentArn (string) –
    
    The Amazon Resource Name (ARN) of the cross-account attachment that specifies the endpoints (resources) that can be added to accelerators and principals that have permission to add the endpoints.
EndpointGroupArn (string) –
[REQUIRED]

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

Return type:

dict

Returns:

Response Syntax

{
    'EndpointDescriptions': [
        {
            'EndpointId': 'string'
        },
    ],
    'EndpointGroupArn': 'string'
}

Response Structure

(dict) –
- EndpointDescriptions (list) –
  
  The endpoint objects added to the custom routing accelerator.
  - (dict) –
    
    A complex type for an endpoint for a custom routing accelerator. Each endpoint group can include one or more endpoints, which are virtual private cloud (VPC) subnets.
    - EndpointId (string) –
      
      An ID for the endpoint. For custom routing accelerators, this is the virtual private cloud (VPC) subnet ID.
- EndpointGroupArn (string) –
  
  The Amazon Resource Name (ARN) of the endpoint group for the custom routing endpoint.

Exceptions

GlobalAccelerator.Client.exceptions.EndpointAlreadyExistsException
GlobalAccelerator.Client.exceptions.EndpointGroupNotFoundException
GlobalAccelerator.Client.exceptions.InternalServiceErrorException
GlobalAccelerator.Client.exceptions.InvalidArgumentException
GlobalAccelerator.Client.exceptions.LimitExceededException
GlobalAccelerator.Client.exceptions.AccessDeniedException
GlobalAccelerator.Client.exceptions.ConflictException