aws-cdk-lib.aws_cloudfront.EdgeLambda

EdgeLambda Struct

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

The type of the AddBehaviorOptions.edgeLambdas property.

Source

aws-cloudfront/lib/distribution.ts

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

eventTypeLambdaEdgeEventTypeevent_typeLambdaEdgeEventTypeeventTypeLambdaEdgeEventTypeEventTypeLambdaEdgeEventTypeEventTypeLambdaEdgeEventTyperequired#

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

functionVersionIVersionfunction_versionIVersionfunctionVersionIVersionFunctionVersionIVersionFunctionVersionIVersionrequired#

The version of the Lambda function that will be invoked.

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

includeBodybooleaninclude_bodyboolincludeBodyBooleanIncludeBodyboolIncludeBody*bool= 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