class KeyValueStore (construct)

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

Implements IConstruct, IDependable, IResource, IKeyValueStore

A CloudFront Key Value Store.

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,
});

Initializer

new KeyValueStore(scope: Construct, id: string, props?: KeyValueStoreProps)

Parameters

• scope Construct
• id string
• props KeyValueStoreProps

Construct Props

Name	Type	Description
comment?	string	A comment for the Key Value Store.
keyValueStoreName?	string	The unique name of the Key Value Store.
source?	ImportSource	The import source for the Key Value Store.

---

comment?

Type: string (optional, default: No comment will be specified)

A comment for the Key Value Store.

---

keyValueStoreName?

Type: string (optional, default: A generated name)

The unique name of the Key Value Store.

---

source?

Type: ImportSource (optional, default: No data will be imported to the store)

The import source for the Key Value Store.

This will populate the initial items in the Key Value Store. The source data must be in a valid JSON format.

Properties

Name	Type	Description
env	ResourceEnvironment	The environment this resource belongs to.
keyValueStoreArn	string	The ARN of the Key Value Store.
keyValueStoreId	string	The Unique ID of the Key Value Store.
keyValueStoreStatus	string	The status of the Key Value Store.
node	Node	The tree node.
stack	Stack	The stack in which this resource is defined.

---

env

Type: ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.

---

keyValueStoreArn

Type: string

The ARN of the Key Value Store.

---

keyValueStoreId

Type: string

The Unique ID of the Key Value Store.

---

keyValueStoreStatus

Type: string

The status of the Key Value Store.

---

node

Type: Node

The tree node.

---

stack

Type: Stack

The stack in which this resource is defined.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
toString()	Returns a string representation of this construct.
static fromKeyValueStoreArn(scope, id, keyValueStoreArn)	Import a Key Value Store using its ARN.

---

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

• policy RemovalPolicy

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

---

toString()

public toString(): string

Returns

• string

Returns a string representation of this construct.

---

static fromKeyValueStoreArn(scope, id, keyValueStoreArn)

public static fromKeyValueStoreArn(scope: Construct, id: string, keyValueStoreArn: string): IKeyValueStore

Parameters

• scope Construct
• id string
• keyValueStoreArn string

Returns

• IKeyValueStore

Import a Key Value Store using its ARN.