AWS::Lambda::WebFunctionEndpoint RegionalEndpoint - AWS CloudFormation
SyntaxProperties
Services or capabilities described in AWS documentation might vary by Region. To see the differences applicable to the AWS European Sovereign Cloud Region, see the AWS European Sovereign Cloud User Guide.

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Lambda::WebFunctionEndpoint RegionalEndpoint

RegionalEndpoint describes the configuration and state of a web function endpoint in one Region. It is a read-only type.

You don't declare RegionalEndpoint in a template. CloudFormation returns it as the values of the endpoint's RegionalEndpoints attribute, which you retrieve with Fn::GetAtt.

Each key in that map is a Region code.

Syntax

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

JSON

{
  "AuthType" : String,
  "DomainName" : String,
  "RevisionWeights" : [ RevisionWeight, ... ],
  "ScalingConfig" : ScalingConfig,
  "State" : String,
  "StateReason" : String,
  "ThrottleConfig" : ThrottleConfig,
  "UpdateStatus" : String,
  "UpdateStatusReason" : String
}

Properties

AuthType

The authorization type for the regional endpoint.

Required: No

Type: String

Allowed values: ApplicationManaged | IamAuth

Update requires: No interruption

DomainName

The domain name of the regional endpoint.

Required: No

Type: String

Update requires: No interruption

RevisionWeights

The revision weights for the regional endpoint.

Required: No

Type: Array of RevisionWeight

Update requires: No interruption

ScalingConfig

The scaling configuration for the regional endpoint.

Required: No

Type: ScalingConfig

Update requires: No interruption

State

The current state of the regional endpoint.

Required: No

Type: String

Allowed values: Pending | Active | Failed | Deleting

Update requires: No interruption

StateReason

The reason for the current state of the regional endpoint.

Required: No

Type: String

Update requires: No interruption

ThrottleConfig

The throttling configuration for the regional endpoint.

Required: No

Type: ThrottleConfig

Update requires: No interruption

UpdateStatus

The status of the most recent update to the regional endpoint.

Required: No

Type: String

Allowed values: InProgress | Successful | Failed

Update requires: No interruption

UpdateStatusReason

The reason for the current update status of the regional endpoint.

Required: No

Type: String

Update requires: No interruption