Package software.amazon.awscdk.services.lambda

Interface CfnWebFunctionEndpointProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebFunctionEndpointProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)",
           date="2026-10-08T16:59:57.649Z")
@Stability(Stable)
public interface CfnWebFunctionEndpointProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnWebFunctionEndpoint.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.lambda.*;
 CfnWebFunctionEndpointProps cfnWebFunctionEndpointProps = CfnWebFunctionEndpointProps.builder()
         .authType("authType")
         .endpointName("endpointName")
         .endpointType("endpointType")
         .functionName("functionName")
         // the properties below are optional
         .description("description")
         .regions(List.of("regions"))
         .revisionWeights(List.of(RevisionWeightProperty.builder()
                 .revisionId("revisionId")
                 .weight(123)
                 .build()))
         .scalingConfig(ScalingConfigProperty.builder()
                 .maxEnvironments(123)
                 .build())
         .throttleConfig(ThrottleConfigProperty.builder()
                 .rateLimit(123)
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebFunctionEndpointProps.Builder	A builder for CfnWebFunctionEndpointProps
static final class	CfnWebFunctionEndpointProps.Jsii$Proxy	An implementation for CfnWebFunctionEndpointProps

Method Summary

Modifier and Type	Method	Description
static CfnWebFunctionEndpointProps.Builder	builder()
String	getAuthType()	The authentication type for the endpoint.
default String	getDescription()	A description of the endpoint.
String	getEndpointName()	The name of the endpoint.
String	getEndpointType()	The type of the endpoint.
String	getFunctionName()	The name of the web function this endpoint belongs to.
default List<String>	getRegions()	The list of AWS Regions for the endpoint.
default Object	getRevisionWeights()	List of revision routing entries.
default Object	getScalingConfig()	The scaling configuration for the endpoint.
default Object	getThrottleConfig()	The throttling configuration for the endpoint.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAuthType

@Stability(Stable)
@NotNull
String getAuthType()

The authentication type for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-authtype

getEndpointName

@Stability(Stable)
@NotNull
String getEndpointName()

The name of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-endpointname

getEndpointType

@Stability(Stable)
@NotNull
String getEndpointType()

The type of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-endpointtype

getFunctionName

@Stability(Stable)
@NotNull
String getFunctionName()

The name of the web function this endpoint belongs to.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-functionname

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-description

getRegions

@Stability(Stable)
@Nullable
default List<String> getRegions()

The list of AWS Regions for the endpoint.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-regions

getRevisionWeights

@Stability(Stable)
@Nullable
default Object getRevisionWeights()

List of revision routing entries.

1 or 2 entries. With 1 entry, weight must be 100. With 2 entries, weights must sum to 100.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnWebFunctionEndpoint.RevisionWeightProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-revisionweights

getScalingConfig

@Stability(Stable)
@Nullable
default Object getScalingConfig()

The scaling configuration for the endpoint.

Optionally constrains how many concurrent execution environments the endpoint can use, in addition to your account's vCPU quota.

Returns union: either IResolvable or CfnWebFunctionEndpoint.ScalingConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-scalingconfig

getThrottleConfig

@Stability(Stable)
@Nullable
default Object getThrottleConfig()

The throttling configuration for the endpoint.

Optionally constrains the request rate that the endpoint accepts, in addition to your account's rate limit quota.

Returns union: either IResolvable or CfnWebFunctionEndpoint.ThrottleConfigProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-lambda-webfunctionendpoint.html#cfn-lambda-webfunctionendpoint-throttleconfig

builder

@Stability(Stable)
static CfnWebFunctionEndpointProps.Builder builder()

Returns:

a CfnWebFunctionEndpointProps.Builder of CfnWebFunctionEndpointProps