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	awscc.globalaccelerator.endpoint_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
endpoint_group_arn	string	The Amazon Resource Name (ARN) of the endpoint group
region	string	AWS region.

For more information, see AWS::GlobalAccelerator::EndpointGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	endpoint_groups	INSERT	ListenerArn, EndpointGroupRegion, region
delete_resource	endpoint_groups	DELETE	Identifier, region
update_resource	endpoint_groups	UPDATE	Identifier, PatchDocument, region
list_resources	endpoint_groups_list_only	SELECT	region
get_resource	endpoint_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.globalaccelerator.endpoint_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ endpoint_group_arn }}';

list (identifiers only)

Lists all endpoint_groups in a region.

SELECT
  region,
  endpoint_group_arn
FROM awscc.globalaccelerator.endpoint_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.globalaccelerator.endpoint_groups (
  ListenerArn,
  EndpointGroupRegion,
  region
)
SELECT
  '{{ listener_arn }}',
  '{{ endpoint_group_region }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.endpoint_groups (
  ListenerArn,
  EndpointGroupRegion,
  EndpointConfigurations,
  TrafficDialPercentage,
  HealthCheckPort,
  HealthCheckProtocol,
  HealthCheckPath,
  HealthCheckIntervalSeconds,
  ThresholdCount,
  PortOverrides,
  region
)
SELECT
  '{{ 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 }}',
  '{{ port_overrides }}',
  '{{ 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: listener_arn
        value: '{{ listener_arn }}'
      - name: endpoint_group_region
        value: '{{ endpoint_group_region }}'
      - name: endpoint_configurations
        value:
          - endpoint_id: '{{ endpoint_id }}'
            attachment_arn: '{{ attachment_arn }}'
            weight: '{{ weight }}'
            client_ip_preservation_enabled: '{{ client_ip_preservation_enabled }}'
      - name: traffic_dial_percentage
        value: null
      - name: health_check_port
        value: '{{ health_check_port }}'
      - name: health_check_protocol
        value: '{{ health_check_protocol }}'
      - name: health_check_path
        value: '{{ health_check_path }}'
      - name: health_check_interval_seconds
        value: '{{ health_check_interval_seconds }}'
      - name: threshold_count
        value: '{{ threshold_count }}'
      - name: port_overrides
        value:
          - listener_port: '{{ listener_port }}'
            endpoint_port: null

UPDATE example

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

/*+ update */
UPDATE awscc.globalaccelerator.endpoint_groups
SET PatchDocument = string('{{ {
    "EndpointConfigurations": endpoint_configurations,
    "TrafficDialPercentage": traffic_dial_percentage,
    "HealthCheckPort": health_check_port,
    "HealthCheckProtocol": health_check_protocol,
    "HealthCheckPath": health_check_path,
    "HealthCheckIntervalSeconds": health_check_interval_seconds,
    "ThresholdCount": threshold_count,
    "PortOverrides": port_overrides
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ endpoint_group_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.globalaccelerator.endpoint_groups
WHERE
  Identifier = '{{ endpoint_group_arn }}' 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