Interface FunctionProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
FunctionProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
date="2024-04-18T17:54:13.736Z")
@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
Modifier and TypeInterfaceDescriptionstatic final class
A builder forFunctionProps
static final class
An implementation forFunctionProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic FunctionProps.Builder
builder()
getCode()
The source code of the function.default String
A comment to describe the function.default String
A name to identify the function.default IKeyValueStore
The Key Value Store to associate with this function.default FunctionRuntime
The runtime environment for the function.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getCode
The source code of the function. -
getComment
A comment to describe the function.Default: - same as `functionName`
-
getFunctionName
A name to identify the function.Default: - generated from the `id`
-
getKeyValueStore
The Key Value Store to associate with this function.In order to associate a Key Value Store, the
runtime
must becloudfront-js-2.0
or newer.Default: - no key value store is associated
-
getRuntime
The runtime environment for the function.Default: FunctionRuntime.JS_1_0 (unless `keyValueStore` is specified, then `FunctionRuntime.JS_2_0`)
-
builder
- Returns:
- a
FunctionProps.Builder
ofFunctionProps
-