AWS CDK

2.273.0

interface CfnWebFunctionEndpointProps

Language	Type name
.NET	`Amazon.CDK.AWS.Lambda.CfnWebFunctionEndpointProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslambda#CfnWebFunctionEndpointProps`
Java	`software.amazon.awscdk.services.lambda.CfnWebFunctionEndpointProps`
Python	`aws_cdk.aws_lambda.CfnWebFunctionEndpointProps`
TypeScript	`aws-cdk-lib` » `aws_lambda` » `CfnWebFunctionEndpointProps`

Properties for defining a CfnWebFunctionEndpoint.

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

Example

// 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

Name	Type	Description
authType	`string`	The authentication type for the endpoint.
endpointName	`string`	The name of the endpoint.
endpointType	`string`	The type of the endpoint.
functionName	`string`	The name of the web function this endpoint belongs to.
description?	`string`	A description of the endpoint.
regions?	`string[]`	The list of AWS Regions for the endpoint.
revisionWeights?	`IResolvable` `\| (IResolvable` `\|` `RevisionWeightProperty)[]`	List of revision routing entries.
scalingConfig?	`IResolvable` `\|` `ScalingConfigProperty`	The scaling configuration for the endpoint.
throttleConfig?	`IResolvable` `\|` `ThrottleConfigProperty`	The throttling configuration for the endpoint.

authType

Type: string

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

endpointName

Type: string

The name of the endpoint.

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

endpointType

Type: string

The type of the endpoint.

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

functionName

Type: string

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

description?

Type: string (optional)

A description of the endpoint.

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

regions?

Type: string[] (optional)

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

revisionWeights?

Type: IResolvable | (IResolvable | RevisionWeightProperty)[] (optional)

List of revision routing entries.

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

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

scalingConfig?

Type: IResolvable | ScalingConfigProperty (optional)

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.

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

throttleConfig?

Type: IResolvable | ThrottleConfigProperty (optional)

The throttling configuration for the endpoint.

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

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

← Previous Next →