interface EdgeLambda

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.EdgeLambda
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#EdgeLambda
Java	software.amazon.awscdk.services.cloudfront.EdgeLambda
Python	aws_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

Name	Type	Description
eventType	LambdaEdgeEventType	The type of event in response to which should the function be invoked.
functionVersion	IVersion	The version of the Lambda function that will be invoked.
includeBody?	boolean	Allows 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