View a markdown version of this page

EndpointConfig - AWS Lambda Web
ContentsSee Also

EndpointConfig

The configuration for a web function endpoint.

Contents

authType

The authorization type for the endpoint.

Valid values:

  • ApplicationManaged – Your application handles authorization.

  • IamAuth – Lambda uses IAM to authorize requests, which must be signed with Signature Version 4 (SigV4).

Type: String

Valid Values: ApplicationManaged | IamAuth

Required: Yes

endpointName

The name of the endpoint. The name can contain letters, numbers, hyphens (-), and underscores (_), and can't begin or end with a hyphen or an underscore. The name is limited to 64 characters in length.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Required: Yes

endpointType

The type of endpoint. Determines how traffic is served and routed across Regions.

Valid values:

  • HomeRegion – Serves traffic from the Region where you created the web function.

  • MultiRegion – Replicates across the Regions that you choose and routes each request to the nearest one.

  • PerRegion – Creates a separate endpoint in each Region that you choose.

Type: String

Valid Values: HomeRegion | MultiRegion | PerRegion

Required: Yes

autoDeploymentMode

The auto-deployment mode for the endpoint. If you don't specify a value, the default is Disabled, and this default is returned in the response.

Valid values:

  • LatestRevision – The endpoint automatically serves the newest revision.

  • Disabled – Revision routing stays fixed until you change it.

Type: String

Valid Values: LatestRevision | Disabled

Required: No

description

A description of the endpoint.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Required: No

regions

The list of Regions for the endpoint. Required when the endpoint type is MultiRegion or PerRegion: specify at least one Region other than the Region where you create the endpoint (the home Region). The home Region is added automatically if you don't include it; specifying only the home Region isn't allowed. When the endpoint type is HomeRegion, omit this field or specify only the home Region.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 100 items.

Length Constraints: Minimum length of 1. Maximum length of 50.

Pattern: ([a-z]{2,}-){2,}[0-9]

Required: No

scalingConfig

The scaling configuration for the endpoint.

Type: ScalingConfig object

Required: No

throttleConfig

The throttling configuration for the endpoint.

Type: ThrottleConfig object

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: