aws-cdk-lib.aws_cloudfront.FunctionProps

FunctionProps Struct

Properties for creating a CloudFront Function.

Source

aws-cloudfront/lib/function.ts

Type last changed

v2.224.0 · 13 Nov 2025

Example

const store = new cloudfront.KeyValueStore(this, 'KeyValueStore');
new cloudfront.Function(this, 'Function', {
  code: cloudfront.FunctionCode.fromInline('function handler(event) { return event.request }'),
  // Note that JS_2_0 must be used for Key Value Store support
  runtime: cloudfront.FunctionRuntime.JS_2_0,
  keyValueStore: store,
});

Properties

autoPublishbooleanauto_publishboolautoPublishBooleanAutoPublishboolAutoPublish*bool= true#

A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.

codeFunctionCodecodeFunctionCodecodeFunctionCodeCodeFunctionCodeCodeFunctionCoderequired#

The source code of the function.

commentstringcommentstrcommentStringCommentstringComment*string= same as `functionName`#

A comment to describe the function.

functionNamestringfunction_namestrfunctionNameStringFunctionNamestringFunctionName*string= generated from the `id`#

A name to identify the function.

keyValueStoreIKeyValueStoreRefkey_value_storeIKeyValueStoreRefkeyValueStoreIKeyValueStoreRefKeyValueStoreIKeyValueStoreRefKeyValueStoreIKeyValueStoreRef= no key value store is associated#

The Key Value Store to associate with this function.

In order to associate a Key Value Store, the runtime must be cloudfront-js-2.0 or newer.

runtimeFunctionRuntimeruntimeFunctionRuntimeruntimeFunctionRuntimeRuntimeFunctionRuntimeRuntimeFunctionRuntime= FunctionRuntime.JS_1_0 (unless `…#

The runtime environment for the function.

default

Default: FunctionRuntime.JS_1_0 (unless keyValueStore is specified, then FunctionRuntime.JS_2_0)

Used as props by

• Function