Skip to content
v2.273.0

CfnWebFunctionEndpointProps Struct Added in v2.273.0 ​

Properties for defining a CfnWebFunctionEndpoint.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lambda as lambda } from 'aws-cdk-lib';
const cfnWebFunctionEndpointProps: lambda.CfnWebFunctionEndpointProps = {
  authType: 'authType',
  endpointName: 'endpointName',
  endpointType: 'endpointType',
  functionName: 'functionName',

  // the properties below are optional
  description: 'description',
  regions: ['regions'],
  revisionWeights: [{
    revisionId: 'revisionId',
    weight: 123,
  }],
  scalingConfig: {
    maxEnvironments: 123,
  },
  throttleConfig: {
    rateLimit: 123,
  },
};

Properties ​

authTypestringauth_typestrauthTypeStringAuthTypestringAuthType*stringrequired#
The authentication type for the endpoint.
descriptionstringdescriptionstrdescriptionStringDescriptionstringDescription*string#
A description of the endpoint.
endpointNamestringendpoint_namestrendpointNameStringEndpointNamestringEndpointName*stringrequired#
The name of the endpoint.
endpointTypestringendpoint_typestrendpointTypeStringEndpointTypestringEndpointType*stringrequired#
The type of the endpoint.
functionNamestringfunction_namestrfunctionNameStringFunctionNamestringFunctionName*stringrequired#
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.

regionsstring[]regionstyping.List[str]regionsList<String>Regionsstring[]Regions*[]*string#
The list of AWS Regions for the endpoint.
revisionWeightsIResolvable | IResolvable | CfnWebFunctionEndpoint.RevisionWeightProperty[]revision_weightstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, RevisionWeightProperty]]]revisionWeightsIResolvableRevisionWeightsIResolvableRevisionWeightsinterface{}#
List of revision routing entries.

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

scalingConfigIResolvable | CfnWebFunctionEndpoint.ScalingConfigPropertyscaling_configtyping.Union[IResolvable, ScalingConfigProperty]scalingConfigIResolvableScalingConfigIResolvableScalingConfiginterface{}#
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.

throttleConfigIResolvable | CfnWebFunctionEndpoint.ThrottleConfigPropertythrottle_configtyping.Union[IResolvable, ThrottleConfigProperty]throttleConfigIResolvableThrottleConfigIResolvableThrottleConfiginterface{}#
The throttling configuration for the endpoint.

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

Used as props by ​