aws-cdk-lib.aws_bedrockagentcore.MemoryBase

MemoryBase L2 construct

Abstract base class for a Memory.

Contains methods and attributes valid for Memories either created with CDK or imported.

Construct›Resource›MemoryBase

implements

• IResource,
• IMemory,
• IGrantable,
• IEnvironmentAware,
• IMemoryRef,
• 2 more

  • IConstruct,
  • IDependable

superclass of

• Memory

Source

aws-bedrockagentcore/lib/memory/memory.ts

Type last changed

v2.255.0 · 19 May 2026

Initializer

new MemoryBase(scope: Construct, id: string, props?: ResourceProps)

MemoryBase(scope: Construct, id: str, props: typing.Optional[ResourceProps] = None)

new MemoryBase(Construct scope, String id, ResourceProps props)

new MemoryBase(Construct scope, string id, ResourceProps? props = null)

NewMemoryBase(Scope Construct, Id *string, Props ResourceProps)

Construct Props

account?optionalstringaccount?optionalstraccount?optionalStringAccount?optionalstringAccount?optional*string#

The AWS account ID this resource belongs to.

Default: the resource is in the same account as the stack it belongs to

environmentFromArn?optionalstringenvironment_from_arn?optionalstrenvironmentFromArn?optionalStringEnvironmentFromArn?optionalstringEnvironmentFromArn?optional*string#

ARN to deduce region and account from.

Default: take environment from account, region parameters, or use Stack environment.

The ARN is parsed and the account and region are taken from the ARN. This should be used for imported resources.

Cannot be supplied together with either account or region.

physicalName?optionalstringphysical_name?optionalstrphysicalName?optionalStringPhysicalName?optionalstringPhysicalName?optional*string#

The value passed in by users to the physical name prop of the resource.

Default: The physical name will be allocated by CloudFormation at deployment time

notes

• undefined implies that a physical name will be allocated by CloudFormation during deployment.
• a concrete value implies a specific physical name
• PhysicalName.GENERATE_IF_NEEDED is a marker that indicates that a physical will only be generated by the CDK if it is needed for cross-environment references. Otherwise, it will be allocated by CloudFormation.

region?optionalstringregion?optionalstrregion?optionalStringRegion?optionalstringRegion?optional*string#

The AWS region this resource belongs to.

Default: the resource is in the same region as the stack it belongs to

Properties

createdAt?may be undefinedstringcreated_at?may be undefinedstrcreatedAt?may be undefinedStringCreatedAt?may be undefinedstringCreatedAt?may be undefined*string#

Timestamp when the memory was created.

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.

executionRole?may be undefinedIRoleexecution_role?may be undefinedIRoleexecutionRole?may be undefinedIRoleExecutionRole?may be undefinedIRoleExecutionRole?may be undefinedIRole#

The IAM role that provides permissions for the memory to access AWS services.

grantPrincipalIPrincipalgrant_principalIPrincipalgrantPrincipalIPrincipalGrantPrincipalIPrincipalGrantPrincipalIPrincipalrequired#

The principal to grant permissions to.

kmsKey?may be undefinedIKeykms_key?may be undefinedIKeykmsKey?may be undefinedIKeyKmsKey?may be undefinedIKeyKmsKey?may be undefinedIKey#

Custom KMS key for encryption (if provided).

memoryArnstringmemory_arnstrmemoryArnStringMemoryArnstringMemoryArn*stringrequired#

The ARN of the memory resource.

memoryIdstringmemory_idstrmemoryIdStringMemoryIdstringMemoryId*stringrequired#

The id of the memory.

memoryRefMemoryReferencememory_refMemoryReferencememoryRefMemoryReferenceMemoryRefMemoryReferenceMemoryRefMemoryReferencerequired#

A reference to a Memory resource.

nodeNodenodeNodenodeNodeNodeNodeNodeNoderequired#

The tree node.

stackStackstackStackstackStackStackStackStackStackrequired#

The stack in which this resource is defined.

status?may be undefinedstringstatus?may be undefinedstrstatus?may be undefinedStringStatus?may be undefinedstringStatus?may be undefined*string#

The status of the memory.

updatedAt?may be undefinedstringupdated_at?may be undefinedstrupdatedAt?may be undefinedStringUpdatedAt?may be undefinedstringUpdatedAt?may be undefined*string#

Timestamp when the memory was last updated.

Methods

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

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, 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#

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.