Package software.amazon.awscdk.services.cloudfront

Interface EdgeLambda

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EdgeLambda.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:05.543Z")
@Stability(Stable)
public interface EdgeLambda
extends software.amazon.jsii.JsiiSerializable

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 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	Description
static final class	EdgeLambda.Builder	A builder for EdgeLambda
static final class	EdgeLambda.Jsii$Proxy	An implementation for EdgeLambda

Method Summary

Modifier and Type	Method	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 Boolean	getIncludeBody()	Allows a Lambda function to have read access to the body content.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEventType

@Stability(Stable)
@NotNull
LambdaEdgeEventType getEventType()

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

getFunctionVersion

@Stability(Stable)
@NotNull
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

@Stability(Stable)
@Nullable
default 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

@Stability(Stable)
static EdgeLambda.Builder builder()

Returns:

a EdgeLambda.Builder of EdgeLambda