Package software.amazon.awscdk.services.lambda

Class CfnWebFunctionEndpoint

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.lambda.CfnWebFunctionEndpoint
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IWebFunctionEndpointRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-10-08T16:59:57.646Z") @Stability(Stable) public class CfnWebFunctionEndpoint extends CfnResource implements IInspectable, IWebFunctionEndpointRef
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.

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.*;
 CfnWebFunctionEndpoint cfnWebFunctionEndpoint = CfnWebFunctionEndpoint.Builder.create(this, "MyCfnWebFunctionEndpoint")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnWebFunctionEndpoint

      protected CfnWebFunctionEndpoint(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnWebFunctionEndpoint

      protected CfnWebFunctionEndpoint(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnWebFunctionEndpoint

      @Stability(Stable) public CfnWebFunctionEndpoint(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnWebFunctionEndpointProps props)
      Create a new AWS::Lambda::WebFunctionEndpoint.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • isCfnWebFunctionEndpoint

      @Stability(Stable) @NotNull public static Boolean isCfnWebFunctionEndpoint(@NotNull Object x)
      Checks whether the given object is a CfnWebFunctionEndpoint.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The timestamp when the endpoint was created.

    • getAttrDomainName

      @Stability(Stable) @NotNull public String getAttrDomainName()
      The domain name of the endpoint.

    • getAttrEndpointArn

      @Stability(Stable) @NotNull public String getAttrEndpointArn()
      The Amazon Resource Name (ARN) of the endpoint.

    • getAttrFunctionArn

      @Stability(Stable) @NotNull public String getAttrFunctionArn()
      The Amazon Resource Name (ARN) of the function.

    • getAttrRegionalEndpoints

      @Stability(Stable) @NotNull public IResolvable getAttrRegionalEndpoints()
      Per-region endpoint status and configuration.

    • getAttrState

      @Stability(Stable) @NotNull public String getAttrState()
      The current state of the endpoint.

    • getAttrStateReason

      @Stability(Stable) @NotNull public String getAttrStateReason()
      The reason for the endpoint's current state.

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()
      The timestamp when the endpoint was last updated.

    • getAttrUpdateStatus

      @Stability(Stable) @NotNull public String getAttrUpdateStatus()
      The status of the last update operation.

    • getAttrUpdateStatusReason

      @Stability(Stable) @NotNull public String getAttrUpdateStatusReason()
      The reason for the update status.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getWebFunctionEndpointRef

      @Stability(Stable) @NotNull public WebFunctionEndpointReference getWebFunctionEndpointRef()
      A reference to a WebFunctionEndpoint resource.
      Specified by:
      getWebFunctionEndpointRef in interface IWebFunctionEndpointRef

    • getAuthType

      @Stability(Stable) @NotNull public String getAuthType()
      The authentication type for the endpoint.

    • setAuthType

      @Stability(Stable) public void setAuthType(@NotNull String value)
      The authentication type for the endpoint.

    • getEndpointName

      @Stability(Stable) @NotNull public String getEndpointName()
      The name of the endpoint.

    • setEndpointName

      @Stability(Stable) public void setEndpointName(@NotNull String value)
      The name of the endpoint.

    • getEndpointType

      @Stability(Stable) @NotNull public String getEndpointType()
      The type of the endpoint.

    • setEndpointType

      @Stability(Stable) public void setEndpointType(@NotNull String value)
      The type of the endpoint.

    • getFunctionName

      @Stability(Stable) @NotNull public String getFunctionName()
      The name of the web function this endpoint belongs to.

    • setFunctionName

      @Stability(Stable) public void setFunctionName(@NotNull String value)
      The name of the web function this endpoint belongs to.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the endpoint.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the endpoint.

    • getRegions

      @Stability(Stable) @Nullable public List<String> getRegions()
      The list of AWS Regions for the endpoint.

    • setRegions

      @Stability(Stable) public void setRegions(@Nullable List<String> value)
      The list of AWS Regions for the endpoint.

    • getRevisionWeights

      @Stability(Stable) @Nullable public Object getRevisionWeights()
      List of revision routing entries.

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

    • setRevisionWeights

      @Stability(Stable) public void setRevisionWeights(@Nullable IResolvable value)
      List of revision routing entries.

    • setRevisionWeights

      @Stability(Stable) public void setRevisionWeights(@Nullable List<Object> value)
      List of revision routing entries.

    • getScalingConfig

      @Stability(Stable) @Nullable public Object getScalingConfig()
      The scaling configuration for the endpoint.

      Returns union: either IResolvable or CfnWebFunctionEndpoint.ScalingConfigProperty

    • setScalingConfig

      @Stability(Stable) public void setScalingConfig(@Nullable IResolvable value)
      The scaling configuration for the endpoint.

    • setScalingConfig

      @Stability(Stable) public void setScalingConfig(@Nullable CfnWebFunctionEndpoint.ScalingConfigProperty value)
      The scaling configuration for the endpoint.

    • getThrottleConfig

      @Stability(Stable) @Nullable public Object getThrottleConfig()
      The throttling configuration for the endpoint.

      Returns union: either IResolvable or CfnWebFunctionEndpoint.ThrottleConfigProperty

    • setThrottleConfig

      @Stability(Stable) public void setThrottleConfig(@Nullable IResolvable value)
      The throttling configuration for the endpoint.

    • setThrottleConfig

      @Stability(Stable) public void setThrottleConfig(@Nullable CfnWebFunctionEndpoint.ThrottleConfigProperty value)
      The throttling configuration for the endpoint.