GlobalAccelerator / Client / create_custom_routing_endpoint_group

create_custom_routing_endpoint_group

GlobalAccelerator.Client.create_custom_routing_endpoint_group(**kwargs)

Create an endpoint group for the specified listener for a custom routing accelerator. An endpoint group is a collection of endpoints in one Amazon Web Services Region.

See also: AWS API Documentation

Request Syntax

response = client.create_custom_routing_endpoint_group(
    ListenerArn='string',
    EndpointGroupRegion='string',
    DestinationConfigurations=[
        {
            'FromPort': 123,
            'ToPort': 123,
            'Protocols': [
                'TCP'|'UDP',
            ]
        },
    ],
    IdempotencyToken='string'
)

Parameters:

• ListenerArn (string) –

  [REQUIRED]

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

• EndpointGroupRegion (string) –

  [REQUIRED]

  The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.

• DestinationConfigurations (list) –

  [REQUIRED]

  Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.

  • (dict) –

    For a custom routing accelerator, sets the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

    • FromPort (integer) – [REQUIRED]

      The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    • ToPort (integer) – [REQUIRED]

      The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

    • Protocols (list) – [REQUIRED]

      The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

      • (string) –

• IdempotencyToken (string) –

  [REQUIRED]

  A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

  This field is autopopulated if not provided.

Return type:

dict

Returns:

Response Syntax

{
    'EndpointGroup': {
        'EndpointGroupArn': 'string',
        'EndpointGroupRegion': 'string',
        'DestinationDescriptions': [
            {
                'FromPort': 123,
                'ToPort': 123,
                'Protocols': [
                    'TCP'|'UDP',
                ]
            },
        ],
        'EndpointDescriptions': [
            {
                'EndpointId': 'string'
            },
        ]
    }
}

Response Structure

• (dict) –

  • EndpointGroup (dict) –

    The information about the endpoint group created for a custom routing accelerator.

    • EndpointGroupArn (string) –

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

    • EndpointGroupRegion (string) –

      The Amazon Web Services Region where the endpoint group is located.

    • DestinationDescriptions (list) –

      For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

      • (dict) –

        For a custom routing accelerator, describes the port range and protocol for all endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

        • FromPort (integer) –

          The first port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

        • ToPort (integer) –

          The last port, inclusive, in the range of ports for the endpoint group that is associated with a custom routing accelerator.

        • Protocols (list) –

          The protocol for the endpoint group that is associated with a custom routing accelerator. The protocol can be either TCP or UDP.

          • (string) –

    • EndpointDescriptions (list) –

      For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.

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

Exceptions

• GlobalAccelerator.Client.exceptions.AcceleratorNotFoundException

• GlobalAccelerator.Client.exceptions.EndpointGroupAlreadyExistsException

• GlobalAccelerator.Client.exceptions.ListenerNotFoundException

• GlobalAccelerator.Client.exceptions.InternalServiceErrorException

• GlobalAccelerator.Client.exceptions.InvalidArgumentException

• GlobalAccelerator.Client.exceptions.InvalidPortRangeException

• GlobalAccelerator.Client.exceptions.LimitExceededException

• GlobalAccelerator.Client.exceptions.AccessDeniedException