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
// Create a Kinesis Data Stream
const stream = new kinesis.Stream(this, 'MemoryEventStream', {
streamName: 'memory-events',
});
const memory = new agentcore.Memory(this, 'MemoryWithStreamDelivery', {
memoryName: 'memory_with_stream',
description: 'Memory with Kinesis stream delivery',
expirationDuration: cdk.Duration.days(90),
streamDeliveryResources: [
agentcore.StreamDeliveryResource.kinesis(stream, {
contentConfigurations: [
{
type: agentcore.StreamDeliveryContentType.MEMORY_RECORDS,
level: agentcore.StreamDeliveryContentLevel.METADATA_ONLY,
},
],
}),
],
});
# Create a Kinesis Data Stream
stream = kinesis.Stream(self, "MemoryEventStream",
stream_name="memory-events"
)
memory = agentcore.Memory(self, "MemoryWithStreamDelivery",
memory_name="memory_with_stream",
description="Memory with Kinesis stream delivery",
expiration_duration=cdk.Duration.days(90),
stream_delivery_resources=[
agentcore.StreamDeliveryResource.kinesis(stream,
content_configurations=[agentcore.StreamDeliveryContentConfiguration(
type=agentcore.StreamDeliveryContentType.MEMORY_RECORDS,
level=agentcore.StreamDeliveryContentLevel.METADATA_ONLY
)
]
)
]
)
// Create a Kinesis Data Stream
Stream stream = Stream.Builder.create(this, "MemoryEventStream")
.streamName("memory-events")
.build();
Memory memory = Memory.Builder.create(this, "MemoryWithStreamDelivery")
.memoryName("memory_with_stream")
.description("Memory with Kinesis stream delivery")
.expirationDuration(Duration.days(90))
.streamDeliveryResources(List.of(StreamDeliveryResource.kinesis(stream, KinesisStreamDeliveryOptions.builder()
.contentConfigurations(List.of(StreamDeliveryContentConfiguration.builder()
.type(StreamDeliveryContentType.MEMORY_RECORDS)
.level(StreamDeliveryContentLevel.METADATA_ONLY)
.build()))
.build())))
.build();
// Install: dotnet add package Amazon.CDK.Lib
// Create a Kinesis Data Stream
var stream = new Stream(this, "MemoryEventStream", new StreamProps {
StreamName = "memory-events"
});
var memory = new Memory(this, "MemoryWithStreamDelivery", new MemoryProps {
MemoryName = "memory_with_stream",
Description = "Memory with Kinesis stream delivery",
ExpirationDuration = Duration.Days(90),
StreamDeliveryResources = new [] { StreamDeliveryResource.Kinesis(stream, new KinesisStreamDeliveryOptions {
ContentConfigurations = new [] { new StreamDeliveryContentConfiguration {
Type = StreamDeliveryContentType.MEMORY_RECORDS,
Level = StreamDeliveryContentLevel.METADATA_ONLY
} }
}) }
});
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// Create a Kinesis Data Stream
stream := kinesis.NewStream(this, jsii.String("MemoryEventStream"), &StreamProps{
StreamName: jsii.String("memory-events"),
})
memory := agentcore.NewMemory(this, jsii.String("MemoryWithStreamDelivery"), &MemoryProps{
MemoryName: jsii.String("memory_with_stream"),
Description: jsii.String("Memory with Kinesis stream delivery"),
ExpirationDuration: cdk.Duration_Days(jsii.Number(90)),
StreamDeliveryResources: []StreamDeliveryResource{
agentcore.StreamDeliveryResource_Kinesis(stream, &KinesisStreamDeliveryOptions{
ContentConfigurations: []StreamDeliveryContentConfiguration{
&StreamDeliveryContentConfiguration{
Type: agentcore.StreamDeliveryContentType_MEMORY_RECORDS,
Level: agentcore.StreamDeliveryContentLevel_METADATA_ONLY,
},
},
}),
},
})
Initializer
new Memory(scope: Construct, id: string, props?: MemoryProps)
Memory(scope: Construct, id: str, props: typing.Optional[MemoryProps] = None)
new Memory(Construct scope, String id, MemoryProps props)
new Memory(Construct scope, string id, MemoryProps? props = null)
NewMemory(Scope Construct, Id *string, Props MemoryProps)
Construct Props
Default: No description
Default: A new role will be created.
expirationDurationDurationexpiration_durationDurationexpirationDurationDurationExpirationDurationDurationExpirationDurationDuration#Default: 90 days
Sets the short-term (raw event) memory retention. Events older than the specified duration will expire and no longer be stored.
Default: Your data is encrypted with a key that AWS owns and manages for you
Default: auto generate
memoryStrategiesIMemoryStrategy[]memory_strategiestyping.List[IMemoryStrategy]memoryStrategiesList<IMemoryStrategy>MemoryStrategiesIMemoryStrategy[]MemoryStrategies*[]IMemoryStrategy#Default: No extraction strategies (short term memory only)
streamDeliveryResourcesStreamDeliveryResource[]stream_delivery_resourcestyping.List[StreamDeliveryResource]streamDeliveryResourcesList<StreamDeliveryResource>StreamDeliveryResourcesStreamDeliveryResource[]StreamDeliveryResources*[]StreamDeliveryResource#Default: No stream delivery (events are not pushed to Kinesis)
notes
The memory execution role will automatically be granted write permissions to each stream.
Only one stream delivery resource is currently supported (CloudFormation maximum); providing more than one fails at synth with TooManyStreamDeliveryResources:
declare const stream: kinesis.IStream;
new agentcore.Memory(this, 'Memory', {
streamDeliveryResources: [
agentcore.StreamDeliveryResource.kinesis(stream, {
contentConfigurations: [{
type: agentcore.StreamDeliveryContentType.MEMORY_RECORDS,
level: agentcore.StreamDeliveryContentLevel.METADATA_ONLY,
}],
}),
],
});
tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Default: no tags
Properties
envResourceEnvironmentenvResourceEnvironmentenvResourceEnvironmentEnvResourceEnvironmentEnvResourceEnvironmentrequired#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.
expirationDurationDurationexpiration_durationDurationexpirationDurationDurationExpirationDurationDurationExpirationDurationDuration#grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#memoryRefMemoryReferencememory_refMemoryReferencememoryRefMemoryReferenceMemoryRefMemoryReferenceMemoryRefMemoryReferencerequired#memoryStrategiesIMemoryStrategy[]memory_strategiestyping.List[IMemoryStrategy]memoryStrategiesList<IMemoryStrategy>MemoryStrategiesIMemoryStrategy[]MemoryStrategies*[]IMemoryStrategyrequired#PROPERTY_INJECTION_IDstringproperty_injection_idstrPROPERTY_INJECTION_IDStringPROPERTY_INJECTION_IDstringPROPERTY_INJECTION_ID*stringrequiredstatic#streamDeliveryResourcesStreamDeliveryResource[]stream_delivery_resourcestyping.List[StreamDeliveryResource]streamDeliveryResourcesList<StreamDeliveryResource>StreamDeliveryResourcesStreamDeliveryResource[]StreamDeliveryResources*[]StreamDeliveryResourcerequired#tags{ [key: string]: string }tagstyping.Mapping[str, str]tagsMap<String, String>TagsIDictionary<string, string>Tags*map[string]*string#Default: No tags applied
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)#addStreamDeliveryResource(resource: StreamDeliveryResource): voiddef add_stream_delivery_resource(self, resource: StreamDeliveryResource) -> Nonepublic void addStreamDeliveryResource(StreamDeliveryResource resource)public void AddStreamDeliveryResource(StreamDeliveryResource resource)func AddStreamDeliveryResource(Resource StreamDeliveryResource)#Grants Kinesis write permissions to the execution role automatically.
1 parameter
Parameters
resourceresourceresourceresourceResource— - The stream delivery resource configuration.
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)#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)#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#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#[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#[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#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#[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#[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#[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#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#[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#[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#[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#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#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#metric(metricName: string, props?: MetricOptions): Metricdef metric(self, metric_name: str, props: typing.Optional[MetricOptions] = None) -> Metricpublic Metric metric(String metricName, MetricOptions props)public Metric Metric(string metricName, MetricOptions? props = null)func Metric(MetricName *string, Props MetricOptions) Metric#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#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#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#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#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#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#toString(): stringdef to_string(self, ) -> strpublic String toString()public string ToString()func ToString() *string#with(...mixins: IMixin[]): IConstructdef with(self, mixins: IMixin) -> IConstructpublic IConstruct with(IMixin mixins)public IConstruct With(IMixin mixins)func With(Mixins IMixin) IConstruct#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.