AWS::Lambda::Url - AWS CloudFormation

AWS::Lambda::Url

The AWS::Lambda::Url resource creates a function URL with the specified configuration parameters. A function URL is a dedicated HTTP(S) endpoint that you can use to invoke your function.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::Lambda::Url", "Properties" : { "AuthType" : String, "Cors" : Cors, "InvokeMode" : String, "Qualifier" : String, "TargetFunctionArn" : String } }

YAML

Type: AWS::Lambda::Url Properties: AuthType: String Cors: Cors InvokeMode: String Qualifier: String TargetFunctionArn: String

Properties

AuthType

The type of authentication that your function URL uses. Set to AWS_IAM if you want to restrict access to authenticated IAM users only. Set to NONE if you want to bypass IAM authentication to create a public endpoint. For more information, see Security and auth model for Lambda function URLs.

Required: Yes

Type: String

Allowed values: AWS_IAM | NONE

Update requires: No interruption

Cors

The Cross-Origin Resource Sharing (CORS) settings for your function URL.

Required: No

Type: Cors

Update requires: No interruption

InvokeMode

Not currently supported by AWS CloudFormation.

Required: No

Type: String

Update requires: No interruption

Qualifier

The alias name.

Required: No

Type: String

Update requires: Replacement

TargetFunctionArn

The name of the Lambda function.

Name formats

  • Function name - my-function.

  • Function ARN - arn:aws:lambda:us-west-2:123456789012:function:my-function.

  • Partial ARN - 123456789012:function:my-function.

The length constraint applies only to the full ARN. If you specify only the function name, it is limited to 64 characters in length.

Required: Yes

Type: String

Update requires: Replacement

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

FunctionArn

The Amazon Resource Name (ARN) of the function.

FunctionUrl

The HTTP URL endpoint for your function.