interface FunctionProps

Language	Type name
.NET	Amazon.CDK.AWS.CloudFront.FunctionProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awscloudfront#FunctionProps
Java	software.amazon.awscdk.services.cloudfront.FunctionProps
Python	aws_cdk.aws_cloudfront.FunctionProps
TypeScript (source)	aws-cdk-lib » aws_cloudfront » FunctionProps

Properties for creating a CloudFront Function.

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

Name	Type	Description
code	FunctionCode	The source code of the function.
autoPublish?	boolean	A flag that determines whether to automatically publish the function to the LIVE stage when it’s created.
comment?	string	A comment to describe the function.
functionName?	string	A name to identify the function.
keyValueStore?	IKeyValueStore	The Key Value Store to associate with this function.
runtime?	FunctionRuntime	The runtime environment for the function.

---

code

Type: FunctionCode

The source code of the function.

---

autoPublish?

Type: boolean (optional, default: true)

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

---

comment?

Type: string (optional, default: same as functionName)

A comment to describe the function.

---

functionName?

Type: string (optional, default: generated from the id)

A name to identify the function.

---

keyValueStore?

Type: IKeyValueStore (optional, default: 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.

---

runtime?

Type: FunctionRuntime (optional, default: FunctionRuntime.JS_1_0 (unless keyValueStore is specified, then FunctionRuntime.JS_2_0))

The runtime environment for the function.