software.amazon.awscdk.services.cloudfront.experimental

Interface EdgeFunctionProps

All Superinterfaces:

EventInvokeConfigOptions, FunctionOptions, FunctionProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

EdgeFunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.168Z")
 @Stability(value=Stable)
public interface EdgeFunctionProps
extends software.amazon.jsii.JsiiSerializable, FunctionProps

Properties for creating a Lambda@Edge function.

Example:

 Bucket myBucket;
 // A Lambda@Edge function added to default behavior of a Distribution
 // and triggered on every request
 EdgeFunction myFunc = EdgeFunction.Builder.create(this, "MyFunction")
         .runtime(Runtime.NODEJS_14_X)
         .handler("index.handler")
         .code(Code.fromAsset(join(__dirname, "lambda-handler")))
         .build();
 Distribution.Builder.create(this, "myDist")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(myBucket))
                 .edgeLambdas(List.of(EdgeLambda.builder()
                         .functionVersion(myFunc.getCurrentVersion())
                         .eventType(LambdaEdgeEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static EdgeFunctionProps.Builder	builder()
default String	getStackId() The stack ID of Lambda@Edge function.

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionProps

getCode, getHandler, getRuntime

Methods inherited from interface software.amazon.awscdk.services.lambda.FunctionOptions

getAllowAllOutbound, getAllowPublicSubnet, getArchitecture, getCodeSigningConfig, getCurrentVersionOptions, getDeadLetterQueue, getDeadLetterQueueEnabled, getDeadLetterTopic, getDescription, getEnvironment, getEnvironmentEncryption, getEphemeralStorageSize, getEvents, getFilesystem, getFunctionName, getInitialPolicy, getInsightsVersion, getLayers, getLogRetention, getLogRetentionRetryOptions, getLogRetentionRole, getMemorySize, getProfiling, getProfilingGroup, getReservedConcurrentExecutions, getRole, getSecurityGroups, getTimeout, getTracing, getVpc, getVpcSubnets

Methods inherited from interface software.amazon.awscdk.services.lambda.EventInvokeConfigOptions

getMaxEventAge, getOnFailure, getOnSuccess, getRetryAttempts

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getStackId

@Stability(value=Stable)
 @Nullable
default String getStackId()

The stack ID of Lambda@Edge function.

Default: - `edge-lambda-stack-${region}`

builder

@Stability(value=Stable)
static EdgeFunctionProps.Builder builder()

Specified by:

builder in interface EventInvokeConfigOptions

Specified by:

builder in interface FunctionOptions

Specified by:

builder in interface FunctionProps

Returns:

a EdgeFunctionProps.Builder of EdgeFunctionProps