AWS Fundamentals Logo
AWS Fundamentals
AWS::VpcLattice::Listener

VpcLattice Listener

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.

Properties

6 configurable properties. 2 required. Click a row to see details.

Filter:
PropertyTypeFlags
DefaultAction
DefaultAction
Required
Protocol
string
RequiredCreate-only
Name
string
Create-only
Port
integer
Create-only
ServiceIdentifier
string
Create-onlyWrite-only
Tags
Array<Tag>

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

AttributeTypeDescription
Arnstring-
Idstring-
ServiceArnstring-
ServiceIdstring-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml
AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::VpcLattice::Listener

Resources:
  MyResource:
    Type: AWS::VpcLattice::Listener
    Properties:
      DefaultAction: "value"
      Protocol: "HTTP"
      Tags:
        - Key: Environment
          Value: Production
      Name: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

vpc-lattice:CreateListenervpc-lattice:TagResourcevpc-lattice:GetListenervpc-lattice:ListTagsForResource

read

vpc-lattice:GetListenervpc-lattice:ListTagsForResource

update

vpc-lattice:UpdateListenervpc-lattice:TagResourcevpc-lattice:UntagResourcevpc-lattice:GetListenervpc-lattice:ListTagsForResource

delete

vpc-lattice:DeleteListener

list

vpc-lattice:ListListeners

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceVpcLattice
Properties10
Required2
TaggingSupported
Primary IDArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

ServiceIdentifierNamePortProtocol

Related Resources

External Links