Package software.amazon.awscdk.services.cloudfront

Interface FunctionProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

FunctionProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.93.0 (build 1706ca5)",
           date="2024-01-03T18:29:22.833Z")
@Stability(Stable)
public interface FunctionProps
extends software.amazon.jsii.JsiiSerializable

Properties for creating a CloudFront Function.

Example:

 Bucket s3Bucket;
 // Add a cloudfront Function to a Distribution
 Function cfFunction = Function.Builder.create(this, "Function")
         .code(FunctionCode.fromInline("function handler(event) { return event.request }"))
         .runtime(FunctionRuntime.JS_2_0)
         .build();
 Distribution.Builder.create(this, "distro")
         .defaultBehavior(BehaviorOptions.builder()
                 .origin(new S3Origin(s3Bucket))
                 .functionAssociations(List.of(FunctionAssociation.builder()
                         .function(cfFunction)
                         .eventType(FunctionEventType.VIEWER_REQUEST)
                         .build()))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static FunctionProps.Builder	builder()
FunctionCode	getCode()	The source code of the function.
default String	getComment()	A comment to describe the function.
default String	getFunctionName()	A name to identify the function.
default FunctionRuntime	getRuntime()	The runtime environment for the function.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCode

@Stability(Stable)
@NotNull
FunctionCode getCode()

The source code of the function.

getComment

@Stability(Stable)
@Nullable
default String getComment()

A comment to describe the function.

Default: - same as `functionName`

getFunctionName

@Stability(Stable)
@Nullable
default String getFunctionName()

A name to identify the function.

Default: - generated from the `id`

getRuntime

@Stability(Stable)
@Nullable
default FunctionRuntime getRuntime()

The runtime environment for the function.

Default: FunctionRuntime.JS_1_0

builder

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

Returns:

a FunctionProps.Builder of FunctionProps