Class: AWSCDK::BedrockAgentCore::CfnRuntime

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

Overview

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime in Amazon Bedrock AgentCore, see Host agent or tools with Amazon Bedrock AgentCore Runtime .

See the Properties section below for descriptions of both the required and optional properties.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnRuntime

Create a new AWS::BedrockAgentCore::Runtime.

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::CfnRuntimeProps) —

    Resource properties.



24
25
26
27
28
29
30
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 24

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

Class Method Details

.arn_for_runtime(resource) ⇒ String

Parameters:

Returns:

  • (String) 


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

def self.arn_for_runtime(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrYWdlbnRjb3JlLklSdW50aW1lUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnRuntime", "arnForRuntime", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.is_cfn_runtime(x) ⇒ Boolean

Checks whether the given object is a CfnRuntime.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
86
87
88
89
90
91
92
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 32

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_agent_runtime_arn => { kind: :property, name: "attrAgentRuntimeArn", is_optional: false },
    :attr_agent_runtime_id => { kind: :property, name: "attrAgentRuntimeId", is_optional: false },
    :attr_agent_runtime_version => { kind: :property, name: "attrAgentRuntimeVersion", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_last_updated_at => { kind: :property, name: "attrLastUpdatedAt", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_workload_identity_details => { kind: :property, name: "attrWorkloadIdentityDetails", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :runtime_ref => { kind: :property, name: "runtimeRef", is_optional: false },
    :agent_runtime_artifact => { kind: :property, name: "agentRuntimeArtifact", is_optional: false },
    :agent_runtime_name => { kind: :property, name: "agentRuntimeName", is_optional: false },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :authorizer_configuration => { kind: :property, name: "authorizerConfiguration", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :environment_variables => { kind: :property, name: "environmentVariables", is_optional: true },
    :filesystem_configurations => { kind: :property, name: "filesystemConfigurations", is_optional: true },
    :lifecycle_configuration => { kind: :property, name: "lifecycleConfiguration", is_optional: true },
    :protocol_configuration => { kind: :property, name: "protocolConfiguration", is_optional: true },
    :request_header_configuration => { kind: :property, name: "requestHeaderConfiguration", 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.



462
463
464
465
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 462

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:



474
475
476
477
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 474

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:



484
485
486
487
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 484

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



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

def add_metadata(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.


552
553
554
555
556
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 552

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.



562
563
564
565
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 562

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.



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

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

#agent_runtime_artifact ⇒ AWSCDK::IResolvable, AWSCDK::BedrockAgentCore::CfnRuntime::AgentRuntimeArtifactProperty

The artifact of the agent.

Returns:



280
281
282
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 280

def agent_runtime_artifact()
  jsii_get_property("agentRuntimeArtifact")
end

#agent_runtime_artifact=(value) ⇒ Object 



284
285
286
287
288
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 284

def agent_runtime_artifact=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnRuntime::AgentRuntimeArtifactProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmblJ1bnRpbWUuQWdlbnRSdW50aW1lQXJ0aWZhY3RQcm9wZXJ0eSJ9XX19")), "agentRuntimeArtifact")
  jsii_set_property("agentRuntimeArtifact", value)
end

#agent_runtime_name ⇒ String

The name of the AgentCore Runtime endpoint.

Returns:

  • (String) 


293
294
295
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 293

def agent_runtime_name()
  jsii_get_property("agentRuntimeName")
end

#agent_runtime_name=(value) ⇒ Object 



297
298
299
300
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 297

def agent_runtime_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentRuntimeName")
  jsii_set_property("agentRuntimeName", 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:



587
588
589
590
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 587

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:

Parameters:

See Also:



609
610
611
612
613
614
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 609

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_agent_runtime_arn ⇒ String

The agent runtime ARN.

Returns:

  • (String) 


210
211
212
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 210

def attr_agent_runtime_arn()
  jsii_get_property("attrAgentRuntimeArn")
end

#attr_agent_runtime_id ⇒ String

The ID for the agent runtime.

Returns:

  • (String) 


217
218
219
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 217

def attr_agent_runtime_id()
  jsii_get_property("attrAgentRuntimeId")
end

#attr_agent_runtime_version ⇒ String

The version for the agent runtime.

Returns:

  • (String) 


224
225
226
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 224

def attr_agent_runtime_version()
  jsii_get_property("attrAgentRuntimeVersion")
end

#attr_created_at ⇒ String

The time at which the runtime was created.

Returns:

  • (String) 


231
232
233
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 231

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reason ⇒ String

The reason for failure if the agent is in a failed state.

Returns:

  • (String) 


238
239
240
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 238

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_last_updated_at ⇒ String

The time at which the runtime was last updated.

Returns:

  • (String) 


245
246
247
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 245

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_status ⇒ String

The status for the agent runtime.

Returns:

  • (String) 


252
253
254
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 252

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_workload_identity_details ⇒ AWSCDK::IResolvable

Configuration for workload identity.

Returns:



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

def attr_workload_identity_details()
  jsii_get_property("attrWorkloadIdentityDetails")
end

#authorizer_configuration ⇒ AWSCDK::IResolvable, ...

Represents inbound authorization configuration options used to authenticate incoming requests.

Returns:



330
331
332
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 330

def authorizer_configuration()
  jsii_get_property("authorizerConfiguration")
end

#authorizer_configuration=(value) ⇒ Object 



334
335
336
337
338
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 334

def authorizer_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnRuntime::AuthorizerConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmblJ1bnRpbWUuQXV0aG9yaXplckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "authorizerConfiguration") unless value.nil?
  jsii_set_property("authorizerConfiguration", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



266
267
268
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 266

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



156
157
158
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 156

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


161
162
163
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 161

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


618
619
620
621
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 618

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


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

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


118
119
120
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 118

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The agent runtime description.

Returns:

  • (String, nil) 


343
344
345
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 343

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



347
348
349
350
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 347

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



178
179
180
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 178

def env()
  jsii_get_property("env")
end

#environment_variables ⇒ AWSCDK::IResolvable, ...

The environment variables for the agent.

Returns:



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

def environment_variables()
  jsii_get_property("environmentVariables")
end

#environment_variables=(value) ⇒ Object 



359
360
361
362
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 359

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

#filesystem_configurations ⇒ AWSCDK::IResolvable, ...

List of filesystem configurations.

Returns:



367
368
369
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 367

def filesystem_configurations()
  jsii_get_property("filesystemConfigurations")
end

#filesystem_configurations=(value) ⇒ Object 



371
372
373
374
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 371

def filesystem_configurations=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5SdW50aW1lLkZpbGVzeXN0ZW1Db25maWd1cmF0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "filesystemConfigurations") unless value.nil?
  jsii_set_property("filesystemConfigurations", 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:



631
632
633
634
635
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 631

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



642
643
644
645
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 642

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

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



712
713
714
715
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 712

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

#lifecycle_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for managing the lifecycle of runtime sessions and resources.

Returns:



379
380
381
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 379

def lifecycle_configuration()
  jsii_get_property("lifecycleConfiguration")
end

#lifecycle_configuration=(value) ⇒ Object 



383
384
385
386
387
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 383

def lifecycle_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnRuntime::LifecycleConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmblJ1bnRpbWUuTGlmZWN5Y2xlQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "lifecycleConfiguration") unless value.nil?
  jsii_set_property("lifecycleConfiguration", value)
end

#logical_id ⇒ String

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) 


130
131
132
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 130

def logical_id()
  jsii_get_property("logicalId")
end

#network_configuration ⇒ AWSCDK::IResolvable, AWSCDK::BedrockAgentCore::CfnRuntime::NetworkConfigurationProperty

The network configuration.

Returns:



305
306
307
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 305

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#network_configuration=(value) ⇒ Object 



309
310
311
312
313
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 309

def network_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnRuntime::NetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmblJ1bnRpbWUuTmV0d29ya0NvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "networkConfiguration")
  jsii_set_property("networkConfiguration", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


113
114
115
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 113

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<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:



653
654
655
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 653

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



660
661
662
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 660

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.



453
454
455
456
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 453

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

#protocol_configuration ⇒ String?

The protocol configuration for an agent runtime.

Returns:

  • (String, nil) 


392
393
394
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 392

def protocol_configuration()
  jsii_get_property("protocolConfiguration")
end

#protocol_configuration=(value) ⇒ Object 



396
397
398
399
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 396

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

#ref ⇒ String

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) 


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

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:



671
672
673
674
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 671

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


678
679
680
681
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 678

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:



688
689
690
691
692
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 688

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

#request_header_configuration ⇒ AWSCDK::IResolvable, ...

Configuration for HTTP request headers.

Returns:



404
405
406
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 404

def request_header_configuration()
  jsii_get_property("requestHeaderConfiguration")
end

#request_header_configuration=(value) ⇒ Object 



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

def request_header_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnRuntime::RequestHeaderConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmblJ1bnRpbWUuUmVxdWVzdEhlYWRlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "requestHeaderConfiguration") unless value.nil?
  jsii_set_property("requestHeaderConfiguration", value)
end

#role_arn ⇒ String

The Amazon Resource Name (ARN) for for the role.

Returns:

  • (String) 


318
319
320
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 318

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



322
323
324
325
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 322

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

#runtime_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::RuntimeReference

A reference to a Runtime resource.

Returns:



273
274
275
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 273

def runtime_ref()
  jsii_get_property("runtimeRef")
end

#should_synthesize ⇒ Boolean

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.



697
698
699
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 697

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



139
140
141
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 139

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

The tags for the agent.

Returns:

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


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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



421
422
423
424
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 421

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_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



429
430
431
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 429

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

#updated_properites ⇒ Hash{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}) 


186
187
188
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 186

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


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

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


703
704
705
706
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 703

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) 


442
443
444
445
446
447
 
# File 'bedrock_agent_core/cfn_runtime.rb', line 442

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