Package software.amazon.awscdk.services.bedrockagentcore

Class CfnMemory

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.bedrockagentcore.CfnMemory

All Implemented Interfaces:

IInspectable, IMemoryRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-12-01T16:02:15.649Z")
@Stability(Stable)
public class CfnMemory
extends CfnResource
implements IInspectable, IMemoryRef, ITaggableV2

Memory allows AI agents to maintain both immediate and long-term knowledge, enabling context-aware and personalized interactions.

For more information about using Memory in Amazon Bedrock AgentCore, see Host agent or tools with Amazon Bedrock AgentCore Memory .

See the Properties section below for descriptions of both the required and optional properties.

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.bedrockagentcore.*;
 CfnMemory cfnMemory = CfnMemory.Builder.create(this, "MyCfnMemory")
         .eventExpiryDuration(123)
         .name("name")
         // the properties below are optional
         .description("description")
         .encryptionKeyArn("encryptionKeyArn")
         .memoryExecutionRoleArn("memoryExecutionRoleArn")
         .memoryStrategies(List.of(MemoryStrategyProperty.builder()
                 .customMemoryStrategy(CustomMemoryStrategyProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .configuration(CustomConfigurationInputProperty.builder()
                                 .selfManagedConfiguration(SelfManagedConfigurationProperty.builder()
                                         .historicalContextWindowSize(123)
                                         .invocationConfiguration(InvocationConfigurationInputProperty.builder()
                                                 .payloadDeliveryBucketName("payloadDeliveryBucketName")
                                                 .topicArn("topicArn")
                                                 .build())
                                         .triggerConditions(List.of(TriggerConditionInputProperty.builder()
                                                 .messageBasedTrigger(MessageBasedTriggerInputProperty.builder()
                                                         .messageCount(123)
                                                         .build())
                                                 .timeBasedTrigger(TimeBasedTriggerInputProperty.builder()
                                                         .idleSessionTimeout(123)
                                                         .build())
                                                 .tokenBasedTrigger(TokenBasedTriggerInputProperty.builder()
                                                         .tokenCount(123)
                                                         .build())
                                                 .build()))
                                         .build())
                                 .semanticOverride(SemanticOverrideProperty.builder()
                                         .consolidation(SemanticOverrideConsolidationConfigurationInputProperty.builder()
                                                 .appendToPrompt("appendToPrompt")
                                                 .modelId("modelId")
                                                 .build())
                                         .extraction(SemanticOverrideExtractionConfigurationInputProperty.builder()
                                                 .appendToPrompt("appendToPrompt")
                                                 .modelId("modelId")
                                                 .build())
                                         .build())
                                 .summaryOverride(SummaryOverrideProperty.builder()
                                         .consolidation(SummaryOverrideConsolidationConfigurationInputProperty.builder()
                                                 .appendToPrompt("appendToPrompt")
                                                 .modelId("modelId")
                                                 .build())
                                         .build())
                                 .userPreferenceOverride(UserPreferenceOverrideProperty.builder()
                                         .consolidation(UserPreferenceOverrideConsolidationConfigurationInputProperty.builder()
                                                 .appendToPrompt("appendToPrompt")
                                                 .modelId("modelId")
                                                 .build())
                                         .extraction(UserPreferenceOverrideExtractionConfigurationInputProperty.builder()
                                                 .appendToPrompt("appendToPrompt")
                                                 .modelId("modelId")
                                                 .build())
                                         .build())
                                 .build())
                         .createdAt("createdAt")
                         .description("description")
                         .namespaces(List.of("namespaces"))
                         .status("status")
                         .strategyId("strategyId")
                         .type("type")
                         .updatedAt("updatedAt")
                         .build())
                 .semanticMemoryStrategy(SemanticMemoryStrategyProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .createdAt("createdAt")
                         .description("description")
                         .namespaces(List.of("namespaces"))
                         .status("status")
                         .strategyId("strategyId")
                         .type("type")
                         .updatedAt("updatedAt")
                         .build())
                 .summaryMemoryStrategy(SummaryMemoryStrategyProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .createdAt("createdAt")
                         .description("description")
                         .namespaces(List.of("namespaces"))
                         .status("status")
                         .strategyId("strategyId")
                         .type("type")
                         .updatedAt("updatedAt")
                         .build())
                 .userPreferenceMemoryStrategy(UserPreferenceMemoryStrategyProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .createdAt("createdAt")
                         .description("description")
                         .namespaces(List.of("namespaces"))
                         .status("status")
                         .strategyId("strategyId")
                         .type("type")
                         .updatedAt("updatedAt")
                         .build())
                 .build()))
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-memory.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnMemory.Builder	A fluent builder for CfnMemory.
static interface	CfnMemory.CustomConfigurationInputProperty	The memory configuration input.
static interface	CfnMemory.CustomMemoryStrategyProperty	The memory strategy.
static interface	CfnMemory.InvocationConfigurationInputProperty	The memory invocation configuration input.
static interface	CfnMemory.MemoryStrategyProperty	The memory strategy.
static interface	CfnMemory.MessageBasedTriggerInputProperty	The message based trigger input.
static interface	CfnMemory.SelfManagedConfigurationProperty	The self managed configuration.
static interface	CfnMemory.SemanticMemoryStrategyProperty	The memory strategy.
static interface	CfnMemory.SemanticOverrideConsolidationConfigurationInputProperty	The memory override configuration.
static interface	CfnMemory.SemanticOverrideExtractionConfigurationInputProperty	The memory override configuration.
static interface	CfnMemory.SemanticOverrideProperty	The memory override.
static interface	CfnMemory.SummaryMemoryStrategyProperty	The memory strategy.
static interface	CfnMemory.SummaryOverrideConsolidationConfigurationInputProperty	The consolidation configuration.
static interface	CfnMemory.SummaryOverrideProperty	The memory summary override.
static interface	CfnMemory.TimeBasedTriggerInputProperty	The memory trigger condition input for the time based trigger.
static interface	CfnMemory.TokenBasedTriggerInputProperty	The token based trigger input.
static interface	CfnMemory.TriggerConditionInputProperty	The memory trigger condition input.
static interface	CfnMemory.UserPreferenceMemoryStrategyProperty	The memory strategy.
static interface	CfnMemory.UserPreferenceOverrideConsolidationConfigurationInputProperty	The configuration input.
static interface	CfnMemory.UserPreferenceOverrideExtractionConfigurationInputProperty	The memory override configuration.
static interface	CfnMemory.UserPreferenceOverrideProperty	The memory user preference override.

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.interfaces.bedrockagentcore.IMemoryRef

IMemoryRef.Jsii$Default, IMemoryRef.Jsii$Proxy

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

ITaggableV2.Jsii$Default, ITaggableV2.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	CfnMemory(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnMemory(software.amazon.jsii.JsiiObjectRef objRef)
	CfnMemory(software.constructs.Construct scope, String id, CfnMemoryProps props)	Create a new AWS::BedrockAgentCore::Memory.

Method Summary

Modifier and Type	Method	Description
static String	arnForMemory(IMemoryRef resource)
String	getAttrCreatedAt()	The timestamp when the memory record was created.
String	getAttrFailureReason()
String	getAttrMemoryArn()	ARN of the Memory resource.
String	getAttrMemoryId()	The memory ID.
String	getAttrStatus()	The memory status.
String	getAttrUpdatedAt()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
String	getDescription()	Description of the Memory resource.
String	getEncryptionKeyArn()	The memory encryption key Amazon Resource Name (ARN).
Number	getEventExpiryDuration()	The event expiry configuration.
String	getMemoryExecutionRoleArn()	The memory role ARN.
MemoryReference	getMemoryRef()	A reference to a Memory resource.
Object	getMemoryStrategies()	The memory strategies.
String	getName()	The memory name.
Map<String,String>	getTags()	The tags for the resources.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
static Boolean	isCfnMemory(Object x)	Checks whether the given object is a CfnMemory.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value)	Description of the Memory resource.
void	setEncryptionKeyArn(String value)	The memory encryption key Amazon Resource Name (ARN).
void	setEventExpiryDuration(Number value)	The event expiry configuration.
void	setMemoryExecutionRoleArn(String value)	The memory role ARN.
void	setMemoryStrategies(List<Object> value)	The memory strategies.
void	setMemoryStrategies(IResolvable value)	The memory strategies.
void	setName(String value)	The memory name.
void	setTags(Map<String,String> value)	The tags for the resources.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getEnv, 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.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.awscdk.interfaces.IEnvironmentAware

getEnv

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

CfnMemory

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

CfnMemory

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

CfnMemory

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

Create a new AWS::BedrockAgentCore::Memory.

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

arnForMemory

@Stability(Stable)
@NotNull
public static String arnForMemory(@NotNull
 IMemoryRef resource)

Parameters:

resource - This parameter is required.

isCfnMemory

@Stability(Stable)
@NotNull
public static Boolean isCfnMemory(@NotNull
 Object x)

Checks whether the given object is a CfnMemory.

Parameters:

x - This parameter is required.

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.

getAttrCreatedAt

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

The timestamp when the memory record was created.

getAttrFailureReason

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

getAttrMemoryArn

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

ARN of the Memory resource.

getAttrMemoryId

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

The memory ID.

getAttrStatus

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

The memory status.

getAttrUpdatedAt

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

getCdkTagManager

@Stability(Stable)
@NotNull
public TagManager getCdkTagManager()

Tag Manager which manages the tags for this resource.

Specified by:

getCdkTagManager in interface ITaggableV2

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getMemoryRef

@Stability(Stable)
@NotNull
public MemoryReference getMemoryRef()

A reference to a Memory resource.

Specified by:

getMemoryRef in interface IMemoryRef

getEventExpiryDuration

@Stability(Stable)
@NotNull
public Number getEventExpiryDuration()

The event expiry configuration.

setEventExpiryDuration

@Stability(Stable)
public void setEventExpiryDuration(@NotNull
 Number value)

The event expiry configuration.

getName

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

The memory name.

setName

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

The memory name.

getDescription

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

Description of the Memory resource.

setDescription

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

Description of the Memory resource.

getEncryptionKeyArn

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

The memory encryption key Amazon Resource Name (ARN).

setEncryptionKeyArn

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

The memory encryption key Amazon Resource Name (ARN).

getMemoryExecutionRoleArn

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

The memory role ARN.

setMemoryExecutionRoleArn

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

The memory role ARN.

getMemoryStrategies

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

The memory strategies.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnMemory.MemoryStrategyProperty>

setMemoryStrategies

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

The memory strategies.

setMemoryStrategies

@Stability(Stable)
public void setMemoryStrategies(@Nullable
 List<Object> value)

The memory strategies.

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

The tags for the resources.

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)

The tags for the resources.