Package software.amazon.awscdk.services.cloudfront

Class CfnKeyValueStore

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.cloudfront.CfnKeyValueStore

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.101.0 (build b95fe5d)",
           date="2024-07-12T19:33:58.629Z")
@Stability(Stable)
public class CfnKeyValueStore
extends CfnResource
implements IInspectable

The key value store.

Use this to separate data from function code, allowing you to update data without having to publish a new version of a function. The key value store holds keys and their corresponding values.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.cloudfront.*;
 CfnKeyValueStore cfnKeyValueStore = CfnKeyValueStore.Builder.create(this, "MyCfnKeyValueStore")
         .name("name")
         // the properties below are optional
         .comment("comment")
         .importSource(ImportSourceProperty.builder()
                 .sourceArn("sourceArn")
                 .sourceType("sourceType")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudfront-keyvaluestore.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnKeyValueStore.Builder	A fluent builder for CfnKeyValueStore.
static interface	CfnKeyValueStore.ImportSourceProperty	The import source for the key value store.

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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the key value store.
String	getAttrId()	The unique Id for the key value store.
String	getAttrStatus()	The current status of the key value store.
protected Map<String,Object>	getCfnProperties()
String	getComment()	A comment for the key value store.
Object	getImportSource()	The import source for the key value store.
String	getName()	The name of the key value store.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setComment(String value)	A comment for the key value store.
void	setImportSource(IResolvable value)	The import source for the key value store.
void	setImportSource(CfnKeyValueStore.ImportSourceProperty value)	The import source for the key value store.
void	setName(String value)	The name of the key value store.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnKeyValueStore

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

CfnKeyValueStore

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

CfnKeyValueStore

@Stability(Stable)
public CfnKeyValueStore(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnKeyValueStoreProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

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

The Amazon Resource Name (ARN) of the key value store.

getAttrId

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

The unique Id for the key value store.

getAttrStatus

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

The current status of the key value store.

For more information, see Key value store statuses in the .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getName

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

The name of the key value store.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the key value store.

getComment

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

A comment for the key value store.

setComment

@Stability(Stable)
public void setComment(@Nullable
 String value)

A comment for the key value store.

getImportSource

@Stability(Stable)
@Nullable
public Object getImportSource()

The import source for the key value store.

setImportSource

@Stability(Stable)
public void setImportSource(@Nullable
 IResolvable value)

The import source for the key value store.

setImportSource

@Stability(Stable)
public void setImportSource(@Nullable
 CfnKeyValueStore.ImportSourceProperty value)

The import source for the key value store.