listeners

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

Overview

Name	listeners
Type	Resource
Description	Creates a listener for a service. Before you start using your Amazon VPC Lattice service, you must add one or more listeners. A listener is a process that checks for connection requests to your services.
Id	awscc.vpclattice.listeners

Fields

get (all properties)

Name	Datatype	Description
arn	string
▶default_action	object
id	string
name	string
port	integer
protocol	string
service_arn	string
service_id	string
service_identifier	string
▶tags	array
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	listeners	INSERT	DefaultAction, 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,
  arn,
  default_action,
  id,
  name,
  port,
  protocol,
  service_arn,
  service_id,
  service_identifier,
  tags
FROM awscc.vpclattice.listeners
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all listeners in a region.

SELECT
  region,
  arn
FROM awscc.vpclattice.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.vpclattice.listeners (
  DefaultAction,
  Protocol,
  region
)
SELECT
  '{{ default_action }}',
  '{{ protocol }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.vpclattice.listeners (
  DefaultAction,
  Name,
  Port,
  Protocol,
  ServiceIdentifier,
  Tags,
  region
)
SELECT
  '{{ default_action }}',
  '{{ name }}',
  '{{ port }}',
  '{{ protocol }}',
  '{{ service_identifier }}',
  '{{ tags }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: listener
    props:
      - name: default_action
        value:
          forward:
            target_groups:
              - target_group_identifier: '{{ target_group_identifier }}'
                weight: '{{ weight }}'
          fixed_response:
            status_code: '{{ status_code }}'
      - name: name
        value: '{{ name }}'
      - name: port
        value: '{{ port }}'
      - name: protocol
        value: '{{ protocol }}'
      - name: service_identifier
        value: '{{ service_identifier }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.vpclattice.listeners
SET PatchDocument = string('{{ {
    "DefaultAction": default_action,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

DELETE example

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

Permissions

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

Create

vpc-lattice:CreateListener,
vpc-lattice:TagResource,
vpc-lattice:GetListener,
vpc-lattice:ListTagsForResource

Read

vpc-lattice:GetListener,
vpc-lattice:ListTagsForResource

Update

vpc-lattice:UpdateListener,
vpc-lattice:TagResource,
vpc-lattice:UntagResource,
vpc-lattice:GetListener,
vpc-lattice:ListTagsForResource

Delete

vpc-lattice:DeleteListener

List

vpc-lattice:ListListeners