custom_routing_listeners

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

Overview

Name	custom_routing_listeners
Type	Resource
Id	aws.globalaccelerator.custom_routing_listeners

Fields

The following fields are returned by SELECT queries:

describe_custom_routing_listener

Name	Datatype	Description
listener_arn	string	The Amazon Resource Name (ARN) of the listener.
port_ranges	array	The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

list_custom_routing_listeners

Name	Datatype	Description
listener_arn	string	The Amazon Resource Name (ARN) of the listener.
port_ranges	array	The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_custom_routing_listener	select	region		The description of a listener for a custom routing accelerator.
list_custom_routing_listeners	select	region		List the listeners for a custom routing accelerator.
create_custom_routing_listener	insert	region, AcceleratorArn, PortRanges, IdempotencyToken		Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.
update_custom_routing_listener	update	region, ListenerArn, PortRanges		Update a listener for a custom routing accelerator.
delete_custom_routing_listener	delete	region		Delete 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_listener

The description of a listener for a custom routing accelerator.

SELECT
listener_arn,
port_ranges
FROM aws.globalaccelerator.custom_routing_listeners
WHERE region = '{{ region }}' -- required
;

list_custom_routing_listeners

List the listeners for a custom routing accelerator.

SELECT
listener_arn,
port_ranges
FROM aws.globalaccelerator.custom_routing_listeners
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_custom_routing_listener

Create a listener to process inbound connections from clients to a custom routing accelerator. Connections arrive to assigned static IP addresses on the port range that you specify.

INSERT INTO aws.globalaccelerator.custom_routing_listeners (
AcceleratorArn,
PortRanges,
IdempotencyToken,
region
)
SELECT 
'{{ AcceleratorArn }}' /* required */,
'{{ PortRanges }}' /* required */,
'{{ IdempotencyToken }}' /* required */,
'{{ region }}'
RETURNING
listener
;

Manifest

# Description fields are for documentation purposes
- name: custom_routing_listeners
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the custom_routing_listeners resource.
  - name: AcceleratorArn
    value: "{{ AcceleratorArn }}"
    description: |
      The Amazon Resource Name (ARN) of the accelerator for a custom routing listener.
  - name: PortRanges
    description: |
      The port range to support for connections from clients to your accelerator. Separately, you set port ranges for endpoints. For more information, see About endpoints for custom routing accelerators.
    value:
      - FromPort: {{ FromPort }}
        ToPort: {{ ToPort }}
  - name: IdempotencyToken
    value: "{{ IdempotencyToken }}"
    description: |
      A unique, case-sensitive identifier that you provide to ensure the idempotency—that is, the uniqueness—of the request.

UPDATE examples

update_custom_routing_listener

Update a listener for a custom routing accelerator.

UPDATE aws.globalaccelerator.custom_routing_listeners
SET 
ListenerArn = '{{ ListenerArn }}',
PortRanges = '{{ PortRanges }}'
WHERE 
region = '{{ region }}' --required
AND ListenerArn = '{{ ListenerArn }}' --required
AND PortRanges = '{{ PortRanges }}' --required
RETURNING
listener;

DELETE examples

delete_custom_routing_listener

Delete a listener for a custom routing accelerator.

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