Class: AWSCDK::BedrockAgentCore::MemoryBase

Inherits:
Resource
  • Object
show all
Includes:
IMemory
Defined in:
bedrock_agent_core/memory_base.rb

Overview

Abstract base class for a Memory.

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

Direct Known Subclasses

Memory

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ MemoryBase

Returns a new instance of MemoryBase.

Parameters:



14
15
16
17
18
19
20
 
# File 'bedrock_agent_core/memory_base.rb', line 14

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::ResourceProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvdXJjZVByb3BzIn0=")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'bedrock_agent_core/memory_base.rb', line 22

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :memory_arn => { kind: :property, name: "memoryArn", is_optional: false },
    :memory_id => { kind: :property, name: "memoryId", is_optional: false },
    :memory_ref => { kind: :property, name: "memoryRef", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :execution_role => { kind: :property, name: "executionRole", is_optional: true },
    :kms_key => { kind: :property, name: "kmsKey", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :updated_at => { kind: :property, name: "updatedAt", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_admin => { kind: :method, name: "grantAdmin", is_optional: false },
    :grant_delete => { kind: :method, name: "grantDelete", is_optional: false },
    :grant_delete_long_term_memory => { kind: :method, name: "grantDeleteLongTermMemory", is_optional: false },
    :grant_delete_short_term_memory => { kind: :method, name: "grantDeleteShortTermMemory", is_optional: false },
    :grant_full_access => { kind: :method, name: "grantFullAccess", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_read_long_term_memory => { kind: :method, name: "grantReadLongTermMemory", is_optional: false },
    :grant_read_short_term_memory => { kind: :method, name: "grantReadShortTermMemory", is_optional: false },
    :grant_write => { kind: :method, name: "grantWrite", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_errors_for_api_operation => { kind: :method, name: "metricErrorsForApiOperation", is_optional: false },
    :metric_event_creation_count => { kind: :method, name: "metricEventCreationCount", is_optional: false },
    :metric_for_api_operation => { kind: :method, name: "metricForApiOperation", is_optional: false },
    :metric_invocations_for_api_operation => { kind: :method, name: "metricInvocationsForApiOperation", is_optional: false },
    :metric_latency_for_api_operation => { kind: :method, name: "metricLatencyForApiOperation", is_optional: false },
    :metric_memory_record_creation_count => { kind: :method, name: "metricMemoryRecordCreationCount", is_optional: false },
  }
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

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:



203
204
205
206
 
# File 'bedrock_agent_core/memory_base.rb', line 203

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

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

Parameters:



220
221
222
223
 
# File 'bedrock_agent_core/memory_base.rb', line 220

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#created_at ⇒ String?

Timestamp when the memory was created.

Returns:

  • (String, nil) 


138
139
140
 
# File 'bedrock_agent_core/memory_base.rb', line 138

def created_at()
  jsii_get_property("createdAt")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

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.

Returns:



82
83
84
 
# File 'bedrock_agent_core/memory_base.rb', line 82

def env()
  jsii_get_property("env")
end

#execution_role ⇒ AWSCDK::IAM::IRole?

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

Returns:



145
146
147
 
# File 'bedrock_agent_core/memory_base.rb', line 145

def execution_role()
  jsii_get_property("executionRole")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


226
227
228
 
# File 'bedrock_agent_core/memory_base.rb', line 226

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


240
241
242
243
244
245
 
# File 'bedrock_agent_core/memory_base.rb', line 240

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


255
256
257
258
 
# File 'bedrock_agent_core/memory_base.rb', line 255

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —
    • The IAM principal to grant permissions to.
  • actions (Array<String>) —
    • The actions to grant.

Returns:



267
268
269
270
271
272
273
 
# File 'bedrock_agent_core/memory_base.rb', line 267

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_admin(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:CreateMemory', 'bedrock-agentcore:GetMemory', 'bedrock-agentcore:DeleteMemory', 'bedrock-agentcore:UpdateMemory'] on this.memoryArn

Grant the given principal identity permissions to manage the control plane of this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



282
283
284
285
 
# File 'bedrock_agent_core/memory_base.rb', line 282

def grant_admin(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantAdmin", [grantee])
end

#grant_delete(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:DeleteEvent', 'bedrock-agentcore:DeleteMemoryRecord'] on this.memoryArn

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]

Parameters:

Returns:



296
297
298
299
 
# File 'bedrock_agent_core/memory_base.rb', line 296

def grant_delete(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantDelete", [grantee])
end

#grant_delete_long_term_memory(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:DeleteMemoryRecord'] on this.memoryArn

Grant the given principal identity permissions to delete Long-Term Memory (LTM) content on this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



308
309
310
311
 
# File 'bedrock_agent_core/memory_base.rb', line 308

def grant_delete_long_term_memory(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantDeleteLongTermMemory", [grantee])
end

#grant_delete_short_term_memory(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:DeleteEvent'] on this.memoryArn

Grant the given principal identity permissions to delete Short-Term Memory (STM) content on this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



320
321
322
323
 
# File 'bedrock_agent_core/memory_base.rb', line 320

def grant_delete_short_term_memory(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantDeleteShortTermMemory", [grantee])
end

#grant_full_access(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:CreateEvent', 'bedrock-agentcore:GetEvent', 'bedrock-agentcore:DeleteEvent', 'bedrock-agentcore:GetMemoryRecord', 'bedrock-agentcore:RetrieveMemoryRecords', 'bedrock-agentcore:ListMemoryRecords', 'bedrock-agentcore:ListActors', 'bedrock-agentcore:ListSessions', 'bedrock-agentcore:CreateMemory', 'bedrock-agentcore:GetMemory', 'bedrock-agentcore:DeleteMemory', 'bedrock-agentcore:UpdateMemory'] on this.memoryArn

Grant the given principal identity permissions to do every action on this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



332
333
334
335
 
# File 'bedrock_agent_core/memory_base.rb', line 332

def grant_full_access(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantFullAccess", [grantee])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



110
111
112
 
# File 'bedrock_agent_core/memory_base.rb', line 110

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:GetMemoryRecord', 'bedrock-agentcore:RetrieveMemoryRecords', 'bedrock-agentcore:ListMemoryRecords', 'bedrock-agentcore:ListActors', 'bedrock-agentcore:ListSessions] on this.memoryArn

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]

Parameters:

Returns:



346
347
348
349
 
# File 'bedrock_agent_core/memory_base.rb', line 346

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_read_long_term_memory(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:GetMemoryRecord', 'bedrock-agentcore:RetrieveMemoryRecords', 'bedrock-agentcore:ListMemoryRecords', 'bedrock-agentcore:ListActors', 'bedrock-agentcore:ListSessions',] on this.memoryArn

Grant the given principal identity permissions to read the Long-Term Memory (LTM) contents of this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



358
359
360
361
 
# File 'bedrock_agent_core/memory_base.rb', line 358

def grant_read_long_term_memory(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantReadLongTermMemory", [grantee])
end

#grant_read_short_term_memory(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:GetEvent', 'bedrock-agentcore:ListEvents', 'bedrock-agentcore:ListActors', 'bedrock-agentcore:ListSessions',] on this.memoryArn

Grant the given principal identity permissions to read the Short-Term Memory (STM) contents of this memory.

[disable-awslint:no-grants]

Parameters:

Returns:



370
371
372
373
 
# File 'bedrock_agent_core/memory_base.rb', line 370

def grant_read_short_term_memory(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantReadShortTermMemory", [grantee])
end

#grant_write(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:CreateEvent'] on this.memoryArn

Grant the given principal identity permissions to write content to short-term memory.

[disable-awslint:no-grants]

Parameters:

Returns:



382
383
384
385
 
# File 'bedrock_agent_core/memory_base.rb', line 382

def grant_write(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantWrite", [grantee])
end

#kms_key ⇒ AWSCDK::KMS::IKey?

Custom KMS key for encryption (if provided).

Returns:



152
153
154
 
# File 'bedrock_agent_core/memory_base.rb', line 152

def kms_key()
  jsii_get_property("kmsKey")
end

#memory_arn ⇒ String

The ARN of the memory resource.

Returns:

  • (String) 


117
118
119
 
# File 'bedrock_agent_core/memory_base.rb', line 117

def memory_arn()
  jsii_get_property("memoryArn")
end

#memory_id ⇒ String

The id of the memory.

Returns:

  • (String) 


124
125
126
 
# File 'bedrock_agent_core/memory_base.rb', line 124

def memory_id()
  jsii_get_property("memoryId")
end

#memory_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::MemoryReference

A reference to a Memory resource.

Returns:



131
132
133
 
# File 'bedrock_agent_core/memory_base.rb', line 131

def memory_ref()
  jsii_get_property("memoryRef")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::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.

Parameters:

Returns:



395
396
397
398
399
400
 
# File 'bedrock_agent_core/memory_base.rb', line 395

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_errors_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return a metric containing the number of errors for a specific API operation performed on this memory.

Parameters:

Returns:



407
408
409
410
411
412
 
# File 'bedrock_agent_core/memory_base.rb', line 407

def metric_errors_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricErrorsForApiOperation", [operation, props])
end

#metric_event_creation_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Returns the metric containing the number of short-term memory events.

Parameters:

Returns:



418
419
420
421
422
 
# File 'bedrock_agent_core/memory_base.rb', line 418

def metric_event_creation_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricEventCreationCount", [props])
end

#metric_for_api_operation(metric_name, operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return the given named metric related to the API operation performed on this memory.

Parameters:

Returns:



430
431
432
433
434
435
436
 
# File 'bedrock_agent_core/memory_base.rb', line 430

def metric_for_api_operation(metric_name, operation, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricForApiOperation", [metric_name, operation, props])
end

#metric_invocations_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return a metric containing the total number of API requests made for a specific memory operation like CreateEvent, ListEvents, RetrieveMemoryRecords ...

Parameters:

Returns:



443
444
445
446
447
448
 
# File 'bedrock_agent_core/memory_base.rb', line 443

def metric_invocations_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricInvocationsForApiOperation", [operation, props])
end

#metric_latency_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Return a metric measuring the latency of a specific API operation performed on this memory.

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.

Parameters:

Returns:



461
462
463
464
465
466
 
# File 'bedrock_agent_core/memory_base.rb', line 461

def metric_latency_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricLatencyForApiOperation", [operation, props])
end

#metric_memory_record_creation_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Returns the metric containing the number of long-term memory records created by the long-term extraction strategies.

Parameters:

Returns:



472
473
474
475
476
 
# File 'bedrock_agent_core/memory_base.rb', line 472

def metric_memory_record_creation_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricMemoryRecordCreationCount", [props])
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


67
68
69
 
# File 'bedrock_agent_core/memory_base.rb', line 67

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


96
97
98
 
# File 'bedrock_agent_core/memory_base.rb', line 96

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



103
104
105
 
# File 'bedrock_agent_core/memory_base.rb', line 103

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of the memory.

Returns:

  • (String, nil) 


159
160
161
 
# File 'bedrock_agent_core/memory_base.rb', line 159

def status()
  jsii_get_property("status")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


173
174
175
 
# File 'bedrock_agent_core/memory_base.rb', line 173

def to_string()
  jsii_call_method("toString", [])
end

#updated_at ⇒ String?

Timestamp when the memory was last updated.

Returns:

  • (String, nil) 


166
167
168
 
# File 'bedrock_agent_core/memory_base.rb', line 166

def updated_at()
  jsii_get_property("updatedAt")
end

#with(*mixins) ⇒ Constructs::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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


186
187
188
189
190
191
 
# File 'bedrock_agent_core/memory_base.rb', line 186

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end