Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
Memory L2 construct
Long-term memory store for extracted insights like user preferences, semantic facts and summaries.
Enables knowledge retention across sessions by storing user preferences (e.g. coding style), semantic facts (e.g. learned info) and interaction summaries for context optimization.
Example
ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
import * as cdk from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_kms as kms } from 'aws-cdk-lib';
declare const key: kms.Key;
declare const memoryStrategy: bedrock_agentcore_alpha.IMemoryStrategy;
declare const role: iam.Role;
const memory = new bedrock_agentcore_alpha.Memory(this, 'MyMemory', /* all optional props */ {
description: 'description',
executionRole: role,
expirationDuration: cdk.Duration.minutes(30),
kmsKey: key,
memoryName: 'memoryName',
memoryStrategies: [memoryStrategy],
tags: {
tagsKey: 'tags',
},
});
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
import aws_cdk as cdk
from aws_cdk import aws_iam as iam
from aws_cdk import aws_kms as kms
# key: kms.Key
# memory_strategy: bedrock_agentcore_alpha.IMemoryStrategy
# role: iam.Role
memory = bedrock_agentcore_alpha.Memory(self, "MyMemory",
description="description",
execution_role=role,
expiration_duration=cdk.Duration.minutes(30),
kms_key=key,
memory_name="memoryName",
memory_strategies=[memory_strategy],
tags={
"tags_key": "tags"
}
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.bedrock.agentcore.alpha.*;
import software.amazon.awscdk.*;
import software.amazon.awscdk.services.iam.*;
import software.amazon.awscdk.services.kms.*;
Key key;
IMemoryStrategy memoryStrategy;
Role role;
Memory memory = Memory.Builder.create(this, "MyMemory")
.description("description")
.executionRole(role)
.expirationDuration(Duration.minutes(30))
.kmsKey(key)
.memoryName("memoryName")
.memoryStrategies(List.of(memoryStrategy))
.tags(Map.of(
"tagsKey", "tags"))
.build();
csharp
// Install: dotnet add package Amazon.CDK.AWS.Bedrock.Agentcore.Alpha
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Bedrock.Agentcore.Alpha;
using Amazon.CDK;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.KMS;
Key key;
IMemoryStrategy memoryStrategy;
Role role;
var memory = new Memory(this, "MyMemory", new MemoryProps {
Description = "description",
ExecutionRole = role,
ExpirationDuration = Duration.Minutes(30),
KmsKey = key,
MemoryName = "memoryName",
MemoryStrategies = new [] { memoryStrategy },
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
}
});
go
// Install: go get github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import bedrock_agentcore_alpha "github.com/aws/aws-cdk-go/awsbedrockagentcorealpha"
import cdk "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
import "github.com/aws/aws-cdk-go/awscdk"
var key Key
var memoryStrategy IMemoryStrategy
var role Role
memory := bedrock_agentcore_alpha.NewMemory(this, jsii.String("MyMemory"), &MemoryProps{
Description: jsii.String("description"),
ExecutionRole: role,
ExpirationDuration: cdk.Duration_Minutes(jsii.Number(30)),
KmsKey: key,
MemoryName: jsii.String("memoryName"),
MemoryStrategies: []IMemoryStrategy{
memoryStrategy,
},
Tags: map[string]*string{
"tagsKey": jsii.String("tags"),
},
})
Initializer
ts
new Memory(scope: Construct, id: string, props?: MemoryProps)
python
Memory(scope: Construct, id: str, props: typing.Optional[MemoryProps] = None)
java
new Memory(Construct scope, String id, MemoryProps props)
csharp
new Memory(Construct scope, string id, MemoryProps? props = null)
go
NewMemory(Scope Construct, Id *string, Props MemoryProps)
Construct Props
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#Optional description for the memory Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.
Default: No description
executionRoleoptionalIRoleexecution_roleoptionalIRoleexecutionRoleoptionalIRoleExecutionRoleoptionalIRoleExecutionRoleoptionalIRole#The IAM role that provides permissions for the memory to access AWS services when using custom strategies.
Default: A new role will be created.
expirationDurationoptionalDurationexpiration_durationoptionalDurationexpirationDurationoptionalDurationExpirationDurationoptionalDurationExpirationDurationoptionalDuration#Short-term memory expiration in days (between 7 and 365).
Default: 90 days
Sets the short-term (raw event) memory retention. Events older than the specified duration will expire and no longer be stored.
Custom KMS key to use for encryption.
Default: Your data is encrypted with a key that AWS owns and manages for you
memoryNameoptionalstringmemory_nameoptionalstrmemoryNameoptionalStringMemoryNameoptionalstringMemoryNameoptional*string#The name of the memory Valid characters are a-z, A-Z, 0-9, _ (underscore) The name must start with a letter and can be up to 48 characters long Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}.
Default: auto generate
memoryStrategiesoptionalIMemoryStrategy[]memory_strategiesoptionaltyping.List[IMemoryStrategy]memoryStrategiesoptionalList<IMemoryStrategy>MemoryStrategiesoptionalIMemoryStrategy[]MemoryStrategiesoptional*[]IMemoryStrategy#If you need long-term memory for context recall across sessions, you can setup memory extraction strategies to extract the relevant memory from the raw events.
Default: No extraction strategies (short term memory only)
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Tags (optional) A list of key:value pairs of tags to apply to this memory resource.
Default: no tags
Properties
createdAtmay be undefinedstringcreated_atmay be undefinedstrcreatedAtmay be undefinedStringCreatedAtmay be undefinedstringCreatedAtmay be undefined*string#The created timestamp of the memory.
descriptionmay be undefinedstringdescriptionmay be undefinedstrdescriptionmay be undefinedStringDescriptionmay be undefinedstringDescriptionmay be undefined*string#The description of the memory.
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#The environment this resource belongs to.
notes
For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.
For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.
executionRolemay be undefinedIRoleexecution_rolemay be undefinedIRoleexecutionRolemay be undefinedIRoleExecutionRolemay be undefinedIRoleExecutionRolemay be undefinedIRole#The execution role of the memory.
expirationDurationmay be undefinedDurationexpiration_durationmay be undefinedDurationexpirationDurationmay be undefinedDurationExpirationDurationmay be undefinedDurationExpirationDurationmay be undefinedDuration#The expiration days of the memory.
failureReasonmay be undefinedstringfailure_reasonmay be undefinedstrfailureReasonmay be undefinedStringFailureReasonmay be undefinedstringFailureReasonmay be undefined*string#The failure reason of the browser.
grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#The principal to grant permissions to.
kmsKeymay be undefinedIKeykms_keymay be undefinedIKeykmsKeymay be undefinedIKeyKmsKeymay be undefinedIKeyKmsKeymay be undefinedIKey#The KMS key used to encrypt the memory.
The ARN of the memory resource.
The id of the memory.
The name of the memory.
memoryRefMemoryReferencememory_refMemoryReferencememoryRefMemoryReferenceMemoryRefMemoryReferenceMemoryRefMemoryReferencerequired#A reference to a Memory resource.
memoryStrategiesIMemoryStrategy[]memory_strategiestyping.List[IMemoryStrategy]memoryStrategiesList<IMemoryStrategy>MemoryStrategiesIMemoryStrategy[]MemoryStrategies*[]IMemoryStrategyrequired#The memory strategies used by the memory.
PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#Uniquely identifies this class.
The stack in which this resource is defined.
statusmay be undefinedstringstatusmay be undefinedstrstatusmay be undefinedStringStatusmay be undefinedstringStatusmay be undefined*string#The status of the memory.
tagsmay be undefined{ [key: string]: string }tagsmay be undefinedtyping.Mapping[str, str]tagsmay be undefinedMap<String, String>Tagsmay be undefinedIDictionary<string, string>Tagsmay be undefined*map[string]*string#Tags applied to this browser resource A map of key-value pairs for resource tagging.
Default: No tags applied
updatedAtmay be undefinedstringupdated_atmay be undefinedstrupdatedAtmay be undefinedStringUpdatedAtmay be undefinedstringUpdatedAtmay be undefined*string#The updated at timestamp of the memory.
Methods
addMemoryStrategy(memoryStrategy: IMemoryStrategy): voiddef add_memory_strategy(self, memory_strategy: IMemoryStrategy) -> Nonepublic void addMemoryStrategy(IMemoryStrategy memoryStrategy)public void AddMemoryStrategy(IMemoryStrategy memoryStrategy)func AddMemoryStrategy(MemoryStrategy IMemoryStrategy)#Add memory strategy to the memory.
applyCrossStackReferenceStrength(strength: ReferenceStrength): voiddef apply_cross_stack_reference_strength(self, strength: ReferenceStrength) -> Nonepublic void applyCrossStackReferenceStrength(ReferenceStrength strength)public void ApplyCrossStackReferenceStrength(ReferenceStrength strength)func ApplyCrossStackReferenceStrength(Strength ReferenceStrength)#Override the cross-stack reference strength for this resource.
notes · 1 parameter
When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.
Parameters
strengthstrengthstrengthstrengthStrength— - The reference strength to use for this resource.
applyRemovalPolicy(policy: RemovalPolicy): voiddef apply_removal_policy(self, policy: RemovalPolicy) -> Nonepublic void applyRemovalPolicy(RemovalPolicy policy)public void ApplyRemovalPolicy(RemovalPolicy policy)func ApplyRemovalPolicy(Policy RemovalPolicy)#Apply the given removal policy to this resource.
notes
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).
fromMemoryAttributes(scope: Construct, id: string, attrs: MemoryAttributes): IMemory@staticmethod def from_memory_attributes(scope: Construct, id: str, attrs: MemoryAttributes) -> IMemorypublic static IMemory fromMemoryAttributes(Construct scope, String id, MemoryAttributes attrs)public static IMemory FromMemoryAttributes(Construct scope, string id, MemoryAttributes attrs)func FromMemoryAttributes(Scope Construct, Id *string, Attrs MemoryAttributes) IMemorystatic#Creates an Memory reference from an existing memory's attributes.
3 parameters · returns
Parameters
scopescopescopescopeScope— - The construct scope.ididididId— - Identifier of the construct.attrsattrsattrsattrsAttrs— - Attributes of the existing browser custom.
Returns: An IBrowserCustom reference to the existing browser
grant(grantee: IGrantable, ...actions: string[]): Grantdef grant(self, grantee: IGrantable, actions: str) -> Grantpublic Grant grant(IGrantable grantee, String actions)public Grant Grant(IGrantable grantee, string actions)func Grant(Grantee IGrantable, Actions *string) Grant#Grants IAM actions to the IAM Principal.
[disable-awslint:no-grants]
2 parameters · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant permissions to.actionsactionsactionsactionsActions— - The actions to grant.
Returns: An IAM Grant object representing the granted permissions
grantAdmin(grantee: IGrantable): Grantdef grant_admin(self, grantee: IGrantable) -> Grantpublic Grant grantAdmin(IGrantable grantee)public Grant GrantAdmin(IGrantable grantee)func GrantAdmin(Grantee IGrantable) Grant#Grant the given principal identity permissions to manage the control plane of this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant admin permissions to.
Returns: An IAM Grant object representing the granted permissions
grantDelete(grantee: IGrantable): Grantdef grant_delete(self, grantee: IGrantable) -> Grantpublic Grant grantDelete(IGrantable grantee)public Grant GrantDelete(IGrantable grantee)func GrantDelete(Grantee IGrantable) Grant#Grant the given principal identity permissions to delete content on this memory.
Both Short-Term Memory (STM) and Long-Term Memory (LTM).
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant delete permissions to.
Returns: An IAM Grant object representing the granted permissions
grantDeleteLongTermMemory(grantee: IGrantable): Grantdef grant_delete_long_term_memory(self, grantee: IGrantable) -> Grantpublic Grant grantDeleteLongTermMemory(IGrantable grantee)public Grant GrantDeleteLongTermMemory(IGrantable grantee)func GrantDeleteLongTermMemory(Grantee IGrantable) Grant#Grant the given principal identity permissions to delete Long-Term Memory (LTM) content on this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant delete permissions to.
Returns: An IAM Grant object representing the granted permissions
grantDeleteShortTermMemory(grantee: IGrantable): Grantdef grant_delete_short_term_memory(self, grantee: IGrantable) -> Grantpublic Grant grantDeleteShortTermMemory(IGrantable grantee)public Grant GrantDeleteShortTermMemory(IGrantable grantee)func GrantDeleteShortTermMemory(Grantee IGrantable) Grant#Grant the given principal identity permissions to delete Short-Term Memory (STM) content on this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant delete permissions to.
Returns: An IAM Grant object representing the granted permissions
grantFullAccess(grantee: IGrantable): Grantdef grant_full_access(self, grantee: IGrantable) -> Grantpublic Grant grantFullAccess(IGrantable grantee)public Grant GrantFullAccess(IGrantable grantee)func GrantFullAccess(Grantee IGrantable) Grant#Grant the given principal identity permissions to do every action on this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant full access permissions to.
Returns: An IAM Grant object representing the granted permissions
grantRead(grantee: IGrantable): Grantdef grant_read(self, grantee: IGrantable) -> Grantpublic Grant grantRead(IGrantable grantee)public Grant GrantRead(IGrantable grantee)func GrantRead(Grantee IGrantable) Grant#Grant the given principal identity permissions to read the contents of this memory.
Both Short-Term Memory (STM) and Long-Term Memory (LTM).
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
Returns: An IAM Grant object representing the granted permissions
grantReadLongTermMemory(grantee: IGrantable): Grantdef grant_read_long_term_memory(self, grantee: IGrantable) -> Grantpublic Grant grantReadLongTermMemory(IGrantable grantee)public Grant GrantReadLongTermMemory(IGrantable grantee)func GrantReadLongTermMemory(Grantee IGrantable) Grant#Grant the given principal identity permissions to read the Long-Term Memory (LTM) contents of this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
Returns: An IAM Grant object representing the granted permissions
grantReadShortTermMemory(grantee: IGrantable): Grantdef grant_read_short_term_memory(self, grantee: IGrantable) -> Grantpublic Grant grantReadShortTermMemory(IGrantable grantee)public Grant GrantReadShortTermMemory(IGrantable grantee)func GrantReadShortTermMemory(Grantee IGrantable) Grant#Grant the given principal identity permissions to read the Short-Term Memory (STM) contents of this memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
Returns: An IAM Grant object representing the granted permissions
grantWrite(grantee: IGrantable): Grantdef grant_write(self, grantee: IGrantable) -> Grantpublic Grant grantWrite(IGrantable grantee)public Grant GrantWrite(IGrantable grantee)func GrantWrite(Grantee IGrantable) Grant#Grant the given principal identity permissions to write content to short-term memory.
[disable-awslint:no-grants]
1 parameter · returns
Parameters
granteegranteegranteegranteeGrantee— - The IAM principal to grant read permissions to.
Returns: An IAM Grant object representing the granted permissions
isConstruct(x: any): boolean@staticmethod def is_construct(x: Any) -> boolpublic static Boolean isConstruct(Object x)public static bool IsConstruct(object x)func IsConstruct(X interface{}) *boolstatic#Checks if `x` is a construct.
notes · 1 parameter · returns
Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.
Parameters
xxxxX— Any object.
Returns: true if x is an object created from a class which extends Construct.
isOwnedResource(construct: IConstruct): boolean@staticmethod def is_owned_resource(construct: IConstruct) -> boolpublic static Boolean isOwnedResource(IConstruct construct)public static bool IsOwnedResource(IConstruct construct)func IsOwnedResource(Construct IConstruct) *boolstatic#Returns true if the construct was created by CDK, and false otherwise.
isResource(construct: IConstruct): boolean@staticmethod def is_resource(construct: IConstruct) -> boolpublic static Boolean isResource(IConstruct construct)public static bool IsResource(IConstruct construct)func IsResource(Construct IConstruct) *boolstatic#Check whether the given construct is a Resource.
metric(metricName: string, dimensions: { [key: string]: string }, props?: MetricOptions): Metricdef metric(self, metric_name: str, dimensions: typing.Mapping[str, str], props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, Map<String, String> dimensions, MetricOptions props)public Metric Metric(string metricName, IDictionary<string, string> dimensions, MetricOptions? props = null)func Metric(MetricName *string, Dimensions *map[string]*string, Props MetricOptions) Metric#Return the given named metric for this memory.
By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.
metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_errors_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricErrorsForApiOperation(String operation, MetricOptions props)public Metric MetricErrorsForApiOperation(string operation, MetricOptions? props = null)func MetricErrorsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the number of errors for a specific API operation performed on this memory.
metricEventCreationCount(props?: MetricOptions): Metricdef metric_event_creation_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricEventCreationCount(MetricOptions props)public Metric MetricEventCreationCount(MetricOptions? props = null)func MetricEventCreationCount(Props MetricOptions) Metric#Returns the metric containing the number of short-term memory events.
metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metricdef metric_for_api_operation(self, metric_name: str, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricForApiOperation(String metricName, String operation, MetricOptions props)public Metric MetricForApiOperation(string metricName, string operation, MetricOptions? props = null)func MetricForApiOperation(MetricName *string, Operation *string, Props MetricOptions) Metric#Return the given named metric related to the API operation performed on this memory.
metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_invocations_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricInvocationsForApiOperation(String operation, MetricOptions props)public Metric MetricInvocationsForApiOperation(string operation, MetricOptions? props = null)func MetricInvocationsForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric containing the total number of API requests made for a specific memory operation like `CreateEvent`, `ListEvents`, `RetrieveMemoryRecords` ...
metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metricdef metric_latency_for_api_operation(self, operation: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricLatencyForApiOperation(String operation, MetricOptions props)public Metric MetricLatencyForApiOperation(string operation, MetricOptions? props = null)func MetricLatencyForApiOperation(Operation *string, Props MetricOptions) Metric#Return a metric measuring the latency of a specific API operation performed on this memory.
notes
The latency metric represents the total time elapsed between receiving the request and sending the final response token, measuring complete end-to-end processing time.
For memory creation events specifically, this measures the time from the last CreateEvent that met strategy criteria until memory storage is completed.
metricMemoryRecordCreationCount(props?: MetricOptions): Metricdef metric_memory_record_creation_count(self, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metricMemoryRecordCreationCount(MetricOptions props)public Metric MetricMemoryRecordCreationCount(MetricOptions? props = null)func MetricMemoryRecordCreationCount(Props MetricOptions) Metric#Returns the metric containing the number of long-term memory records created by the long-term extraction strategies.
toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#Returns a string representation of this construct.
with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#Applies one or more mixins to this construct.
Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.