Skip to main content

endpoint_groups

Creates, updates, deletes, gets or lists an endpoint_groups resource.

Overview​

Nameendpoint_groups
TypeResource
Idaws.globalaccelerator.endpoint_groups

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
endpoint_descriptionsarrayThe list of endpoint objects.
endpoint_group_arnstringThe Amazon Resource Name (ARN) of the endpoint group.
endpoint_group_regionstringThe Amazon Web Services Region where the endpoint group is located.
health_check_interval_secondsintegerThe time—10 seconds or 30 seconds—between health checks for each endpoint. The default value is 30.
health_check_pathstringIf the protocol is HTTP/S, then this value provides the ping path that Global Accelerator uses for the destination on the endpoints for health checks. The default is slash (/). (pattern: <code>^/[-a-zA-Z0-9@:%_\+.~#?&/=]*$</code>)
health_check_portintegerThe port that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default port is the port for the listener that this endpoint group is associated with. If the listener port is a list, Global Accelerator uses the first specified port in the list of ports.
health_check_protocolstringThe protocol that Global Accelerator uses to perform health checks on endpoints that are part of this endpoint group. The default value is TCP. (TCP, HTTP, HTTPS)
port_overridesarrayAllows you to override the destination ports used to route traffic to an endpoint. Using a port override lets you map a list of external destination ports (that your users send traffic to) to a list of internal destination ports that you want an application endpoint to receive traffic on.
threshold_countintegerThe number of consecutive health checks required to set the state of a healthy endpoint to unhealthy, or to set an unhealthy endpoint to healthy. The default value is 3.
traffic_dial_percentagenumber (float)The percentage of traffic to send to an Amazon Web Services Region. Additional traffic is distributed to other endpoint groups for this listener. Use this action to increase (dial up) or decrease (dial down) traffic to a specific Region. The percentage is applied to the traffic that would otherwise have been routed to the Region based on optimal routing. The default value is 100.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
describe_endpoint_groupselectregionDescribe an endpoint group.
list_endpoint_groupsselectregionList the endpoint groups that are associated with a listener.
create_endpoint_groupinsertregion, ListenerArn, EndpointGroupRegion, IdempotencyTokenCreate an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint. For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
add_custom_routing_endpointsupdateregion, EndpointConfigurations, EndpointGroupArnAssociate 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.
remove_custom_routing_endpointsupdateregion, EndpointIds, EndpointGroupArnRemove endpoints from a custom routing accelerator.
remove_endpointsupdateregion, EndpointIdentifiers, EndpointGroupArnRemove endpoints from an endpoint group. The RemoveEndpoints API operation is the recommended option for removing endpoints. The alternative is to remove endpoints by updating an endpoint group by using the UpdateEndpointGroup API operation. There are two advantages to using AddEndpoints to remove endpoints instead: It's more convenient, because you only need to specify the endpoints that you want to remove. With the UpdateEndpointGroup API operation, you must specify all of the endpoints in the endpoint group except the ones that you want to remove from the group. It's faster, because Global Accelerator doesn't need to resolve any endpoints. With the UpdateEndpointGroup API operation, Global Accelerator must resolve all of the endpoints that remain in the group.
update_endpoint_groupupdateregion, EndpointGroupArnUpdate an endpoint group. A resource must be valid and active when you add it as an endpoint.
delete_endpoint_groupdeleteregionDelete an endpoint group from a listener.
add_endpointsexecregion, EndpointConfigurations, EndpointGroupArnAdd endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints in Global Accelerator: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints. It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add. For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.
allow_custom_routing_trafficexecregion, EndpointGroupArn, EndpointIdSpecify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that can receive traffic for a custom routing accelerator. You can allow traffic to all destinations in the subnet endpoint, or allow traffic to a specified list of destination IP addresses and ports in the subnet. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.
deny_custom_routing_trafficexecregion, EndpointGroupArn, EndpointIdSpecify the Amazon EC2 instance (destination) IP addresses and ports for a VPC subnet endpoint that cannot receive traffic for a custom routing accelerator. You can deny traffic to all destinations in the VPC endpoint, or deny traffic to a specified list of destination IP addresses and ports. Note that you cannot specify IP addresses or ports outside of the range that you configured for the endpoint group. After you make changes, you can verify that the updates are complete by checking the status of your accelerator: the status changes from IN_PROGRESS to DEPLOYED.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
regionstringAWS region (default: us-east-1)

SELECT examples​

Describe an endpoint group.

SELECT
endpoint_descriptions,
endpoint_group_arn,
endpoint_group_region,
health_check_interval_seconds,
health_check_path,
health_check_port,
health_check_protocol,
port_overrides,
threshold_count,
traffic_dial_percentage
FROM aws.globalaccelerator.endpoint_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples​

Create an endpoint group for the specified listener. An endpoint group is a collection of endpoints in one Amazon Web Services Region. A resource must be valid and active when you add it as an endpoint. For more information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

INSERT INTO aws.globalaccelerator.endpoint_groups (
ListenerArn,
EndpointGroupRegion,
EndpointConfigurations,
TrafficDialPercentage,
HealthCheckPort,
HealthCheckProtocol,
HealthCheckPath,
HealthCheckIntervalSeconds,
ThresholdCount,
IdempotencyToken,
PortOverrides,
region
)
SELECT 
'{{ ListenerArn }}' /* required */,
'{{ EndpointGroupRegion }}' /* required */,
'{{ EndpointConfigurations }}',
{{ TrafficDialPercentage }},
{{ HealthCheckPort }},
'{{ HealthCheckProtocol }}',
'{{ HealthCheckPath }}',
{{ HealthCheckIntervalSeconds }},
{{ ThresholdCount }},
'{{ IdempotencyToken }}' /* required */,
'{{ PortOverrides }}',
'{{ region }}'
RETURNING
endpoint_group
;

UPDATE examples​

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.

UPDATE aws.globalaccelerator.endpoint_groups
SET 
EndpointConfigurations = '{{ EndpointConfigurations }}',
EndpointGroupArn = '{{ EndpointGroupArn }}'
WHERE 
region = '{{ region }}' --required
AND EndpointConfigurations = '{{ EndpointConfigurations }}' --required
AND EndpointGroupArn = '{{ EndpointGroupArn }}' --required
RETURNING
endpoint_descriptions,
endpoint_group_arn;

DELETE examples​

Delete an endpoint group from a listener.

DELETE FROM aws.globalaccelerator.endpoint_groups
WHERE region = '{{ region }}' --required
;

Lifecycle Methods​

Add endpoints to an endpoint group. The AddEndpoints API operation is the recommended option for adding endpoints. The alternative options are to add endpoints when you create an endpoint group (with the CreateEndpointGroup API) or when you update an endpoint group (with the UpdateEndpointGroup API). There are two advantages to using AddEndpoints to add endpoints in Global Accelerator: It's faster, because Global Accelerator only has to resolve the new endpoints that you're adding, rather than resolving new and existing endpoints. It's more convenient, because you don't need to specify the current endpoints that are already in the endpoint group, in addition to the new endpoints that you want to add. For information about endpoint types and requirements for endpoints that you can add to Global Accelerator, see Endpoints for standard accelerators in the Global Accelerator Developer Guide.

EXEC aws.globalaccelerator.endpoint_groups.add_endpoints 
@region='{{ region }}' --required 
@@json=
'{
"EndpointConfigurations": "{{ EndpointConfigurations }}", 
"EndpointGroupArn": "{{ EndpointGroupArn }}"
}'
;
Last updated on