Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

CreateCustomRoutingEndpointGroup

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

Request Syntax


{
   "DestinationConfigurations": [ 
      { 
         "FromPort": number,
         "Protocols": [ "string" ],
         "ToPort": number
      }
   ],
   "EndpointGroupRegion": "string",
   "IdempotencyToken": "string",
   "ListenerArn": "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.

DestinationConfigurations

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

Type: Array of CustomRoutingDestinationConfiguration objects

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

Required: Yes

EndpointGroupRegion

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

IdempotencyToken

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

ListenerArn

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

Type: String

Length Constraints: Maximum length of 255.

Required: Yes

Response Syntax


{
   "EndpointGroup": { 
      "DestinationDescriptions": [ 
         { 
            "FromPort": number,
            "Protocols": [ "string" ],
            "ToPort": number
         }
      ],
      "EndpointDescriptions": [ 
         { 
            "EndpointId": "string"
         }
      ],
      "EndpointGroupArn": "string",
      "EndpointGroupRegion": "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.

EndpointGroup

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

Type: CustomRoutingEndpointGroup object

Errors

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

AcceleratorNotFoundException

The accelerator that you specified doesn't exist.

HTTP Status Code: 400

AccessDeniedException

You don't have access permission.

HTTP Status Code: 400

EndpointGroupAlreadyExistsException

The endpoint group that you specified already exists.

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

InvalidPortRangeException

The port numbers that you specified are not valid numbers or are not unique for this accelerator.

HTTP Status Code: 400

LimitExceededException

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

HTTP Status Code: 400

ListenerNotFoundException

The listener that you specified doesn't exist.

HTTP Status Code: 400

Examples

Create an endpoint group for a custom routing accelerator

The following is an example of creating an endpoint group for a custom routing accelerator, and the response.


aws globalaccelerator create-custom-routing-endpoint-group 
           --listener-arn arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz 
           --endpoint-group-region us-east-1 
           --endpoint-configurations EndpointId=i-1234567890abcdef0,Weight=128
           --region us-west-2


{
    "EndpointGroup": {
        "EndpointId": "i-1234567890abcdef0"
        "EndpointGroupArn": "arn:aws:globalaccelerator::012345678901:accelerator/1234abcd-abcd-1234-abcd-1234abcdefgh/listener/0123vxyz/endpoint-group/098765zyxwvu", 
        "EndpointGroupRegion": "us-east-1"
    }
}