[ aws . globalaccelerator ]

add-custom-routing-endpoints

Description

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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  add-custom-routing-endpoints
--endpoint-configurations <value>
--endpoint-group-arn <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--endpoint-configurations (list)

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

(structure)

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.

Shorthand Syntax:

EndpointId=string ...

JSON Syntax:

[
  {
    "EndpointId": "string"
  }
  ...
]

--endpoint-group-arn (string)

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

--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.

Output

EndpointDescriptions -> (list)

The endpoint objects added to the custom routing accelerator.

(structure)

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.