endpoint_groups

Creates, updates, deletes or gets an endpoint_group resource or lists endpoint_groups in a region

Overview

Name	endpoint_groups
Type	Resource
Description	Resource Type definition for AWS::GlobalAccelerator::EndpointGroup
Id	aws.globalaccelerator.endpoint_groups

Fields

Name	Datatype	Description
listener_arn	string	The Amazon Resource Name (ARN) of the listener
endpoint_group_region	string	The name of the AWS Region where the endpoint group is located
endpoint_configurations	array	The list of endpoint objects.
traffic_dial_percentage	number	The percentage of traffic to sent to an AWS Region
health_check_port	integer	The port that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_protocol	string	The protocol that AWS Global Accelerator uses to check the health of endpoints in this endpoint group.
health_check_path	string
health_check_interval_seconds	integer	The time in seconds between each health check for an endpoint. Must be a value of 10 or 30
threshold_count	integer	The number of consecutive health checks required to set the state of the endpoint to unhealthy.
endpoint_group_arn	string	The Amazon Resource Name (ARN) of the endpoint group
port_overrides	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	ListenerArn, EndpointGroupRegion, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all endpoint_groups in a region.

SELECT
region,
listener_arn,
endpoint_group_region,
endpoint_configurations,
traffic_dial_percentage,
health_check_port,
health_check_protocol,
health_check_path,
health_check_interval_seconds,
threshold_count,
endpoint_group_arn,
port_overrides
FROM aws.globalaccelerator.endpoint_groups
;

Gets all properties from an individual endpoint_group.

SELECT
region,
listener_arn,
endpoint_group_region,
endpoint_configurations,
traffic_dial_percentage,
health_check_port,
health_check_protocol,
health_check_path,
health_check_interval_seconds,
threshold_count,
endpoint_group_arn,
port_overrides
FROM aws.globalaccelerator.endpoint_groups
WHERE data__Identifier = '<EndpointGroupArn>';

INSERT example

Use the following StackQL query and manifest file to create a new endpoint_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.globalaccelerator.endpoint_groups (
 ListenerArn,
 EndpointGroupRegion,
 region
)
SELECT 
'{{ ListenerArn }}',
 '{{ EndpointGroupRegion }}',
'{{ region }}';

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: endpoint_group
    props:
      - name: ListenerArn
        value: '{{ ListenerArn }}'
      - name: EndpointGroupRegion
        value: '{{ EndpointGroupRegion }}'
      - name: EndpointConfigurations
        value:
          - EndpointId: '{{ EndpointId }}'
            AttachmentArn: '{{ AttachmentArn }}'
            Weight: '{{ Weight }}'
            ClientIPPreservationEnabled: '{{ ClientIPPreservationEnabled }}'
      - name: TrafficDialPercentage
        value: null
      - name: HealthCheckPort
        value: '{{ HealthCheckPort }}'
      - name: HealthCheckProtocol
        value: '{{ HealthCheckProtocol }}'
      - name: HealthCheckPath
        value: '{{ HealthCheckPath }}'
      - name: HealthCheckIntervalSeconds
        value: '{{ HealthCheckIntervalSeconds }}'
      - name: ThresholdCount
        value: '{{ ThresholdCount }}'
      - name: PortOverrides
        value:
          - ListenerPort: '{{ ListenerPort }}'
            EndpointPort: null

DELETE example

/*+ delete */
DELETE FROM aws.globalaccelerator.endpoint_groups
WHERE data__Identifier = '<EndpointGroupArn>'
AND region = 'us-east-1';

Permissions

To operate on the endpoint_groups resource, the following permissions are required:

Create

globalaccelerator:CreateEndpointGroup,
globalaccelerator:DescribeEndpointGroup,
globalaccelerator:DescribeAccelerator,
globalaccelerator:DescribeListener,
globalaccelerator:ListAccelerators,
globalaccelerator:ListListeners

Read

globalaccelerator:DescribeEndpointGroup

Update

globalaccelerator:UpdateEndpointGroup,
globalaccelerator:DescribeEndpointGroup,
globalaccelerator:DescribeListener,
globalaccelerator:DescribeAccelerator

Delete

globalaccelerator:DeleteEndpointGroup,
globalaccelerator:DescribeEndpointGroup,
globalaccelerator:DescribeAccelerator

List

globalaccelerator:ListEndpointGroups