listeners

Creates, updates, deletes or gets a listener resource or lists listeners in a region

Overview

Name	listeners
Type	Resource
Description	Resource Type definition for AWS::GlobalAccelerator::Listener
Id	awscc.globalaccelerator.listeners

Fields

get (all properties)

Name	Datatype	Description
listener_arn	string	The Amazon Resource Name (ARN) of the listener.
accelerator_arn	string	The Amazon Resource Name (ARN) of the accelerator.
▶port_ranges	array
protocol	string	The protocol for the listener.
client_affinity	string	Client affinity lets you direct all requests from a user to the same endpoint.
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
listener_arn	string	The Amazon Resource Name (ARN) of the listener.
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	listeners	INSERT	AcceleratorArn, PortRanges, Protocol, region
delete_resource	listeners	DELETE	Identifier, region
update_resource	listeners	UPDATE	Identifier, PatchDocument, region
list_resources	listeners_list_only	SELECT	region
get_resource	listeners	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual listener.

SELECT
  region,
  listener_arn,
  accelerator_arn,
  port_ranges,
  protocol,
  client_affinity
FROM awscc.globalaccelerator.listeners
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ listener_arn }}';

list (identifiers only)

Lists all listeners in a region.

SELECT
  region,
  listener_arn
FROM awscc.globalaccelerator.listeners_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.listeners (
  AcceleratorArn,
  PortRanges,
  Protocol,
  region
)
SELECT
  '{{ accelerator_arn }}',
  '{{ port_ranges }}',
  '{{ protocol }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.globalaccelerator.listeners (
  AcceleratorArn,
  PortRanges,
  Protocol,
  ClientAffinity,
  region
)
SELECT
  '{{ accelerator_arn }}',
  '{{ port_ranges }}',
  '{{ protocol }}',
  '{{ client_affinity }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: listener
    props:
      - name: accelerator_arn
        value: '{{ accelerator_arn }}'
      - name: port_ranges
        value:
          - from_port: '{{ from_port }}'
            to_port: null
      - name: protocol
        value: '{{ protocol }}'
      - name: client_affinity
        value: '{{ client_affinity }}'

UPDATE example

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

/*+ update */
UPDATE awscc.globalaccelerator.listeners
SET PatchDocument = string('{{ {
    "PortRanges": port_ranges,
    "Protocol": protocol,
    "ClientAffinity": client_affinity
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ listener_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.globalaccelerator.listeners
WHERE
  Identifier = '{{ listener_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

globalaccelerator:CreateListener,
globalaccelerator:DescribeListener,
globalaccelerator:DescribeAccelerator

Read

globalaccelerator:DescribeListener

Update

globalaccelerator:UpdateListener,
globalaccelerator:DescribeListener,
globalaccelerator:DescribeAccelerator

Delete

globalaccelerator:DescribeListener,
globalaccelerator:DeleteListener,
globalaccelerator:DescribeAccelerator

List

globalaccelerator:ListListeners