Package software.amazon.awscdk.services.cloudfront

Interface KeyValueStoreProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

KeyValueStoreProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-05T20:26:28.136Z")
@Stability(Stable)
public interface KeyValueStoreProps
extends software.amazon.jsii.JsiiSerializable

The properties to create a Key Value Store.

Example:

 KeyValueStore storeAsset = KeyValueStore.Builder.create(this, "KeyValueStoreAsset")
         .keyValueStoreName("KeyValueStoreAsset")
         .source(ImportSource.fromAsset("path-to-data.json"))
         .build();
 KeyValueStore storeInline = KeyValueStore.Builder.create(this, "KeyValueStoreInline")
         .keyValueStoreName("KeyValueStoreInline")
         .source(ImportSource.fromInline(JSON.stringify(Map.of(
                 "data", List.of(Map.of(
                         "key", "key1",
                         "value", "value1"), Map.of(
                         "key", "key2",
                         "value", "value2"))))))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static KeyValueStoreProps.Builder	builder()
default String	getComment()	A comment for the Key Value Store.
default String	getKeyValueStoreName()	The unique name of the Key Value Store.
default ImportSource	getSource()	The import source for the Key Value Store.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getComment

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

A comment for the Key Value Store.

Default: No comment will be specified

getKeyValueStoreName

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

The unique name of the Key Value Store.

Default: A generated name

getSource

@Stability(Stable)
@Nullable
default ImportSource getSource()

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.

Default: No data will be imported to the store

builder

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

Returns:

a KeyValueStoreProps.Builder of KeyValueStoreProps