software.amazon.awscdk.services.cloudfront

Interface EdgeLambda

All Known Implementing Classes:

EdgeLambda.Jsii$Proxy

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.070Z")
public interface EdgeLambda

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

The type of the {@link AddBehaviorOptions.edgeLambdas} property.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 import software.amazon.awscdk.services.lambda.*;
 Version version;
 EdgeLambda edgeLambda = EdgeLambda.builder()
         .eventType(LambdaEdgeEventType.ORIGIN_REQUEST)
         .functionVersion(version)
         // the properties below are optional
         .includeBody(false)
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	EdgeLambda.Builder A builder for EdgeLambda
static class	EdgeLambda.Jsii$Proxy An implementation for EdgeLambda

Method Summary

Modifier and Type	Method and Description
static EdgeLambda.Builder	builder()
LambdaEdgeEventType	getEventType() The type of event in response to which should the function be invoked.
IVersion	getFunctionVersion() The version of the Lambda function that will be invoked.
default java.lang.Boolean	getIncludeBody() Allows a Lambda function to have read access to the body content.

Method Detail

getEventType

LambdaEdgeEventType getEventType()

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

getFunctionVersion

IVersion getFunctionVersion()

The version of the Lambda function that will be invoked.

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

getIncludeBody

default java.lang.Boolean getIncludeBody()

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

Default: false

builder

static EdgeLambda.Builder builder()

Returns:

a EdgeLambda.Builder of EdgeLambda