Class: AWSCDK::BedrockAgentCore::CfnMemory

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSBedrockagentcore::IMemoryRef
Defined in:
bedrock_agent_core/cfn_memory.rb

Overview

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.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMemory

Create a new AWS::BedrockAgentCore::Memory.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::BedrockAgentCore::CfnMemoryProps)

    Resource properties.



22
23
24
25
26
27
28
# File 'bedrock_agent_core/cfn_memory.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnMemoryProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5NZW1vcnlQcm9wcyJ9")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_memory(resource) ⇒ String

Parameters:

Returns:

  • (String)


89
90
91
92
# File 'bedrock_agent_core/cfn_memory.rb', line 89

def self.arn_for_memory(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrYWdlbnRjb3JlLklNZW1vcnlSZWYifQ==")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnMemory", "arnForMemory", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


196
197
198
# File 'bedrock_agent_core/cfn_memory.rb', line 196

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrockagentcore.CfnMemory", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_memory(x) ⇒ Boolean

Checks whether the given object is a CfnMemory.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


98
99
100
101
# File 'bedrock_agent_core/cfn_memory.rb', line 98

def self.is_cfn_memory(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnMemory", "isCfnMemory", [x])
end

.jsii_overridable_methodsObject



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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'bedrock_agent_core/cfn_memory.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_memory_arn => { kind: :property, name: "attrMemoryArn", is_optional: false },
    :attr_memory_id => { kind: :property, name: "attrMemoryId", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :memory_ref => { kind: :property, name: "memoryRef", is_optional: false },
    :event_expiry_duration => { kind: :property, name: "eventExpiryDuration", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :description => { kind: :property, name: "description", is_optional: true },
    :encryption_key_arn => { kind: :property, name: "encryptionKeyArn", is_optional: true },
    :indexed_keys => { kind: :property, name: "indexedKeys", is_optional: true },
    :memory_execution_role_arn => { kind: :property, name: "memoryExecutionRoleArn", is_optional: true },
    :memory_strategies => { kind: :property, name: "memoryStrategies", is_optional: true },
    :stream_delivery_resources => { kind: :property, name: "streamDeliveryResources", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



395
396
397
398
# File 'bedrock_agent_core/cfn_memory.rb', line 395

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



407
408
409
410
# File 'bedrock_agent_core/cfn_memory.rb', line 407

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



417
418
419
420
# File 'bedrock_agent_core/cfn_memory.rb', line 417

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



428
429
430
431
432
# File 'bedrock_agent_core/cfn_memory.rb', line 428

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


485
486
487
488
489
# File 'bedrock_agent_core/cfn_memory.rb', line 485

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



495
496
497
498
# File 'bedrock_agent_core/cfn_memory.rb', line 495

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



507
508
509
510
511
# File 'bedrock_agent_core/cfn_memory.rb', line 507

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



520
521
522
523
# File 'bedrock_agent_core/cfn_memory.rb', line 520

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



542
543
544
545
546
547
# File 'bedrock_agent_core/cfn_memory.rb', line 542

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_created_atString

The timestamp when the memory record was created.

Returns:

  • (String)


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

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reasonString

Returns:

  • (String)


208
209
210
# File 'bedrock_agent_core/cfn_memory.rb', line 208

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_memory_arnString

ARN of the Memory resource.

Returns:

  • (String)


215
216
217
# File 'bedrock_agent_core/cfn_memory.rb', line 215

def attr_memory_arn()
  jsii_get_property("attrMemoryArn")
end

#attr_memory_idString

The memory ID.

Returns:

  • (String)


222
223
224
# File 'bedrock_agent_core/cfn_memory.rb', line 222

def attr_memory_id()
  jsii_get_property("attrMemoryId")
end

#attr_statusString

The memory status.

Returns:

  • (String)


229
230
231
# File 'bedrock_agent_core/cfn_memory.rb', line 229

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_updated_atString

Returns:

  • (String)


234
235
236
# File 'bedrock_agent_core/cfn_memory.rb', line 234

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



241
242
243
# File 'bedrock_agent_core/cfn_memory.rb', line 241

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



149
150
151
# File 'bedrock_agent_core/cfn_memory.rb', line 149

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


154
155
156
# File 'bedrock_agent_core/cfn_memory.rb', line 154

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


551
552
553
554
# File 'bedrock_agent_core/cfn_memory.rb', line 551

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


111
112
113
# File 'bedrock_agent_core/cfn_memory.rb', line 111

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

Description of the Memory resource.

Returns:

  • (String, nil)


279
280
281
# File 'bedrock_agent_core/cfn_memory.rb', line 279

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



283
284
285
286
# File 'bedrock_agent_core/cfn_memory.rb', line 283

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#encryption_key_arnString?

The memory encryption key Amazon Resource Name (ARN).

Returns:

  • (String, nil)


291
292
293
# File 'bedrock_agent_core/cfn_memory.rb', line 291

def encryption_key_arn()
  jsii_get_property("encryptionKeyArn")
end

#encryption_key_arn=(value) ⇒ Object



295
296
297
298
# File 'bedrock_agent_core/cfn_memory.rb', line 295

def encryption_key_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "encryptionKeyArn") unless value.nil?
  jsii_set_property("encryptionKeyArn", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



171
172
173
# File 'bedrock_agent_core/cfn_memory.rb', line 171

def env()
  jsii_get_property("env")
end

#event_expiry_durationNumeric

The event expiry configuration.

Returns:

  • (Numeric)


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

def event_expiry_duration()
  jsii_get_property("eventExpiryDuration")
end

#event_expiry_duration=(value) ⇒ Object



259
260
261
262
# File 'bedrock_agent_core/cfn_memory.rb', line 259

def event_expiry_duration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "eventExpiryDuration")
  jsii_set_property("eventExpiryDuration", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



564
565
566
567
568
# File 'bedrock_agent_core/cfn_memory.rb', line 564

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



575
576
577
578
# File 'bedrock_agent_core/cfn_memory.rb', line 575

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#indexed_keysAWSCDK::IResolvable, ...

List of indexed keys for the memory.



303
304
305
# File 'bedrock_agent_core/cfn_memory.rb', line 303

def indexed_keys()
  jsii_get_property("indexedKeys")
end

#indexed_keys=(value) ⇒ Object



307
308
309
310
# File 'bedrock_agent_core/cfn_memory.rb', line 307

def indexed_keys=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5NZW1vcnkuSW5kZXhlZEtleVByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "indexedKeys") unless value.nil?
  jsii_set_property("indexedKeys", value)
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



645
646
647
648
# File 'bedrock_agent_core/cfn_memory.rb', line 645

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


123
124
125
# File 'bedrock_agent_core/cfn_memory.rb', line 123

def logical_id()
  jsii_get_property("logicalId")
end

#memory_execution_role_arnString?

The memory role ARN.

Returns:

  • (String, nil)


315
316
317
# File 'bedrock_agent_core/cfn_memory.rb', line 315

def memory_execution_role_arn()
  jsii_get_property("memoryExecutionRoleArn")
end

#memory_execution_role_arn=(value) ⇒ Object



319
320
321
322
# File 'bedrock_agent_core/cfn_memory.rb', line 319

def memory_execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "memoryExecutionRoleArn") unless value.nil?
  jsii_set_property("memoryExecutionRoleArn", value)
end

#memory_refAWSCDK::Interfaces::AWSBedrockagentcore::MemoryReference

A reference to a Memory resource.



248
249
250
# File 'bedrock_agent_core/cfn_memory.rb', line 248

def memory_ref()
  jsii_get_property("memoryRef")
end

#memory_strategiesAWSCDK::IResolvable, ...

The memory strategies.



327
328
329
# File 'bedrock_agent_core/cfn_memory.rb', line 327

def memory_strategies()
  jsii_get_property("memoryStrategies")
end

#memory_strategies=(value) ⇒ Object



331
332
333
334
# File 'bedrock_agent_core/cfn_memory.rb', line 331

def memory_strategies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5NZW1vcnkuTWVtb3J5U3RyYXRlZ3lQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "memoryStrategies") unless value.nil?
  jsii_set_property("memoryStrategies", value)
end

#nameString

The memory name.

Returns:

  • (String)


267
268
269
# File 'bedrock_agent_core/cfn_memory.rb', line 267

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



271
272
273
274
# File 'bedrock_agent_core/cfn_memory.rb', line 271

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


106
107
108
# File 'bedrock_agent_core/cfn_memory.rb', line 106

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



586
587
588
# File 'bedrock_agent_core/cfn_memory.rb', line 586

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



593
594
595
# File 'bedrock_agent_core/cfn_memory.rb', line 593

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



386
387
388
389
# File 'bedrock_agent_core/cfn_memory.rb', line 386

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


142
143
144
# File 'bedrock_agent_core/cfn_memory.rb', line 142

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



604
605
606
607
# File 'bedrock_agent_core/cfn_memory.rb', line 604

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


611
612
613
614
# File 'bedrock_agent_core/cfn_memory.rb', line 611

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



621
622
623
624
625
# File 'bedrock_agent_core/cfn_memory.rb', line 621

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



630
631
632
# File 'bedrock_agent_core/cfn_memory.rb', line 630

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



132
133
134
# File 'bedrock_agent_core/cfn_memory.rb', line 132

def stack()
  jsii_get_property("stack")
end

#stream_delivery_resourcesAWSCDK::IResolvable, ...



337
338
339
# File 'bedrock_agent_core/cfn_memory.rb', line 337

def stream_delivery_resources()
  jsii_get_property("streamDeliveryResources")
end

#stream_delivery_resources=(value) ⇒ Object



341
342
343
344
345
# File 'bedrock_agent_core/cfn_memory.rb', line 341

def stream_delivery_resources=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnMemory::StreamDeliveryResourcesProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbk1lbW9yeS5TdHJlYW1EZWxpdmVyeVJlc291cmNlc1Byb3BlcnR5In1dfX0=")), "streamDeliveryResources") unless value.nil?
  jsii_set_property("streamDeliveryResources", value)
end

#tagsHash{String => String}?

The tags for the resources.

Returns:

  • (Hash{String => String}, nil)


350
351
352
# File 'bedrock_agent_core/cfn_memory.rb', line 350

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



354
355
356
357
# File 'bedrock_agent_core/cfn_memory.rb', line 354

def tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



362
363
364
# File 'bedrock_agent_core/cfn_memory.rb', line 362

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

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


179
180
181
# File 'bedrock_agent_core/cfn_memory.rb', line 179

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


189
190
191
# File 'bedrock_agent_core/cfn_memory.rb', line 189

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


636
637
638
639
# File 'bedrock_agent_core/cfn_memory.rb', line 636

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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)


375
376
377
378
379
380
# File 'bedrock_agent_core/cfn_memory.rb', line 375

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