Package software.amazon.awscdk.services.cloudfront

Class KeyValueStore

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.Resource

software.amazon.awscdk.services.cloudfront.KeyValueStore

All Implemented Interfaces:

IResource, IKeyValueStore, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:03.878Z")
@Stability(Stable)
public class KeyValueStore
extends Resource
implements IKeyValueStore

A CloudFront 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	Class	Description
static final class	KeyValueStore.Builder	A fluent builder for KeyValueStore.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.cloudfront.IKeyValueStore

IKeyValueStore.Jsii$Default, IKeyValueStore.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.IResource

IResource.Jsii$Default

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	KeyValueStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	KeyValueStore(software.amazon.jsii.JsiiObjectRef objRef)
	KeyValueStore(software.constructs.Construct scope, String id)
	KeyValueStore(software.constructs.Construct scope, String id, KeyValueStoreProps props)

Method Summary

Modifier and Type	Method	Description
static IKeyValueStore	fromKeyValueStoreArn(software.constructs.Construct scope, String id, String keyValueStoreArn)	Import a Key Value Store using its ARN.
String	getKeyValueStoreArn()	The ARN of the Key Value Store.
String	getKeyValueStoreId()	The Unique ID of the Key Value Store.
String	getKeyValueStoreStatus()	The status of the Key Value Store.

Methods inherited from class software.amazon.awscdk.Resource

applyRemovalPolicy, generatePhysicalName, getEnv, getPhysicalName, getResourceArnAttribute, getResourceNameAttribute, getStack, isOwnedResource, isResource

Methods inherited from class software.constructs.Construct

getNode, isConstruct, toString

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.IResource

applyRemovalPolicy, getEnv, getStack

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Constructor Details

KeyValueStore

protected KeyValueStore(software.amazon.jsii.JsiiObjectRef objRef)

KeyValueStore

protected KeyValueStore(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

KeyValueStore

@Stability(Stable)
public KeyValueStore(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 KeyValueStoreProps props)

Parameters:

scope - This parameter is required.

id - This parameter is required.

props -

KeyValueStore

@Stability(Stable)
public KeyValueStore(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Method Details

fromKeyValueStoreArn

@Stability(Stable)
@NotNull
public static IKeyValueStore fromKeyValueStoreArn(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 String keyValueStoreArn)

Import a Key Value Store using its ARN.

Parameters:

scope - This parameter is required.

id - This parameter is required.

keyValueStoreArn - This parameter is required.

getKeyValueStoreArn

@Stability(Stable)
@NotNull
public String getKeyValueStoreArn()

The ARN of the Key Value Store.

Specified by:

getKeyValueStoreArn in interface IKeyValueStore

getKeyValueStoreId

@Stability(Stable)
@NotNull
public String getKeyValueStoreId()

The Unique ID of the Key Value Store.

Specified by:

getKeyValueStoreId in interface IKeyValueStore

getKeyValueStoreStatus

@Stability(Stable)
@NotNull
public String getKeyValueStoreStatus()

The status of the Key Value Store.

Specified by:

getKeyValueStoreStatus in interface IKeyValueStore