aws-cdk-lib.aws_cloudfront.EdgeLambda

interface EdgeLambda

LanguageType name
.NETAmazon.CDK.AWS.CloudFront.EdgeLambda
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#EdgeLambda
Javasoftware.amazon.awscdk.services.cloudfront.EdgeLambda
Pythonaws_cdk.aws_cloudfront.EdgeLambda
TypeScript (source)aws-cdk-lib » aws_cloudfront » EdgeLambda

Represents a Lambda function version and event type when using Lambda@Edge.

The type of the AddBehaviorOptions.edgeLambdas property.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cloudfront as cloudfront } from 'aws-cdk-lib';
import { aws_lambda as lambda } from 'aws-cdk-lib';

declare const version: lambda.Version;
const edgeLambda: cloudfront.EdgeLambda = {
  eventType: cloudfront.LambdaEdgeEventType.ORIGIN_REQUEST,
  functionVersion: version,

  // the properties below are optional
  includeBody: false,
};

Properties

NameTypeDescription
eventTypeLambdaEdgeEventTypeThe type of event in response to which should the function be invoked.
functionVersionIVersionThe version of the Lambda function that will be invoked.
includeBody?booleanAllows a Lambda function to have read access to the body content.

eventType

Type: LambdaEdgeEventType

The type of event in response to which should the function be invoked.


functionVersion

Type: IVersion

The version of the Lambda function that will be invoked.

Note: it's not possible to use the '$LATEST' function version for Lambda@Edge!


includeBody?

Type: boolean (optional, default: false)

Allows a Lambda function to have read access to the body content.

Only valid for "request" event types (ORIGIN_REQUEST or VIEWER_REQUEST). See https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/lambda-include-body-access.html