AWS::Lambda::WebFunctionEndpoint

Lambda WebFunctionEndpoint

Resource Type definition for AWS::Lambda::WebFunctionEndpoint. An endpoint exposes a Lambda web function over HTTPS and routes traffic to one or more revisions. The endpoint type determines how traffic is served and routed across Regions.

Properties

9 configurable properties. 4 required. Click a row to see details.

Filter:

Property	Type	Flags
`AuthType`	`string`	Required
`EndpointName`	`string`	RequiredCreate-only
`EndpointType`	`string`	RequiredCreate-only
`FunctionName`	`string`	RequiredCreate-only
`Description`	`string`
`Regions`	`Array<string>`	Create-only
`RevisionWeights`	`Array<RevisionWeight>`
`ScalingConfig`	`ScalingConfig`
`ThrottleConfig`	`ThrottleConfig`

Return Values

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

Attribute	Type	Description
`CreatedAt`	`string`	The timestamp when the endpoint was created.
`DomainName`	`string`	The domain name of the endpoint.
`EndpointArn`	`string`	The Amazon Resource Name (ARN) of the endpoint.
`FunctionArn`	`string`	The Amazon Resource Name (ARN) of the function.
`RegionalEndpoints`	`object`	Per-region endpoint status and configuration.
`State`	`string`	The current state of the endpoint.
`StateReason`	`string`	The reason for the endpoint's current state.
`UpdatedAt`	`string`	The timestamp when the endpoint was last updated.
`UpdateStatus`	`string`	The status of the last update operation.
`UpdateStatusReason`	`string`	The reason for the update status.

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::Lambda::WebFunctionEndpoint

Resources:
  MyResource:
    Type: AWS::Lambda::WebFunctionEndpoint
    Properties:
      FunctionName: "my-functionname"
      EndpointName: "my-endpointname"
      EndpointType: "HomeRegion"
      AuthType: "ApplicationManaged"
      Description: !Ref "AWS::StackName"

Required IAM Permissions

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

create

lambda:CreateWebFunctionEndpointlambda:GetWebFunctionEndpoint

read

lambda:GetWebFunctionEndpoint

update

lambda:UpdateWebFunctionEndpointlambda:GetWebFunctionEndpoint

delete

lambda:DeleteWebFunctionEndpointlambda:GetWebFunctionEndpoint

list

lambda:ListWebFunctionEndpoints

Get the Lambda Cheat Sheet

Everything you need to know about Lambda on one page. HD quality, print-friendly.

Download Free Infographic

Quick Facts

ServiceLambda

Properties19

Required4

TaggingNot supported

Primary IDEndpointArn

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

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

FunctionNameEndpointNameEndpointTypeRegions

Related Resources

External Links

AWS Documentation