custom_routing_endpoint_groups

Creates, updates, deletes, gets or lists a custom_routing_endpoint_groups resource.

Overview

Name	custom_routing_endpoint_groups
Type	Resource
Id	aws.globalaccelerator.custom_routing_endpoint_groups

Fields

The following fields are returned by SELECT queries:

describe_custom_routing_endpoint_group

Name	Datatype	Description
destination_descriptions	array	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.
endpoint_descriptions	array	For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
endpoint_group_arn	string	The Amazon Resource Name (ARN) of the endpoint group.
endpoint_group_region	string	The Amazon Web Services Region where the endpoint group is located.

list_custom_routing_endpoint_groups

Name	Datatype	Description
destination_descriptions	array	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.
endpoint_descriptions	array	For a custom routing accelerator, describes the endpoints (virtual private cloud subnets) in an endpoint group to accept client traffic on.
endpoint_group_arn	string	The Amazon Resource Name (ARN) of the endpoint group.
endpoint_group_region	string	The Amazon Web Services Region where the endpoint group is located.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_routing_endpoint_group	select	region		Describe an endpoint group for a custom routing accelerator.
list_custom_routing_endpoint_groups	select	region		List the endpoint groups that are associated with a listener for a custom routing accelerator.
create_custom_routing_endpoint_group	insert	region, ListenerArn, EndpointGroupRegion, DestinationConfigurations, IdempotencyToken		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.
delete_custom_routing_endpoint_group	delete	region		Delete an endpoint group from a listener for a custom routing accelerator.

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.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_custom_routing_endpoint_group

Describe an endpoint group for a custom routing accelerator.

SELECT
destination_descriptions,
endpoint_descriptions,
endpoint_group_arn,
endpoint_group_region
FROM aws.globalaccelerator.custom_routing_endpoint_groups
WHERE region = '{{ region }}' -- required
;

list_custom_routing_endpoint_groups

List the endpoint groups that are associated with a listener for a custom routing accelerator.

SELECT
destination_descriptions,
endpoint_descriptions,
endpoint_group_arn,
endpoint_group_region
FROM aws.globalaccelerator.custom_routing_endpoint_groups
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_routing_endpoint_group

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.

INSERT INTO aws.globalaccelerator.custom_routing_endpoint_groups (
ListenerArn,
EndpointGroupRegion,
DestinationConfigurations,
IdempotencyToken,
region
)
SELECT 
'{{ ListenerArn }}' /* required */,
'{{ EndpointGroupRegion }}' /* required */,
'{{ DestinationConfigurations }}' /* required */,
'{{ IdempotencyToken }}' /* required */,
'{{ region }}'
RETURNING
endpoint_group
;

Manifest

# Description fields are for documentation purposes
- name: custom_routing_endpoint_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_routing_endpoint_groups resource.
  - name: ListenerArn
    value: "{{ ListenerArn }}"
    description: |
      The Amazon Resource Name (ARN) of the listener for a custom routing endpoint.
  - name: EndpointGroupRegion
    value: "{{ EndpointGroupRegion }}"
    description: |
      The Amazon Web Services Region where the endpoint group is located. A listener can have only one endpoint group in a specific Region.
  - name: DestinationConfigurations
    description: |
      Sets the port range and protocol for all endpoints (virtual private cloud subnets) in a custom routing endpoint group to accept client traffic on.
    value:
      - FromPort: {{ FromPort }}
        ToPort: {{ ToPort }}
        Protocols: "{{ Protocols }}"
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

DELETE examples

delete_custom_routing_endpoint_group

Delete an endpoint group from a listener for a custom routing accelerator.

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