Class: AWSCDK::BedrockAgentCore::CfnRuntimeEndpoint

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

Overview

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 endpoints in Amazon Bedrock AgentCore, see AgentCore Runtime versioning and endpoints .

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) ⇒ CfnRuntimeEndpoint

Create a new AWS::BedrockAgentCore::RuntimeEndpoint.

Parameters:



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

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

Class Method Details

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


188
189
190
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 188

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

.is_cfn_runtime_endpoint(x) ⇒ Boolean

Checks whether the given object is a CfnRuntimeEndpoint.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


90
91
92
93
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 90

def self.is_cfn_runtime_endpoint(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnRuntimeEndpoint", "isCfnRuntimeEndpoint", [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
# File 'bedrock_agent_core/cfn_runtime_endpoint.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_agent_runtime_arn => { kind: :property, name: "attrAgentRuntimeArn", is_optional: false },
    :attr_agent_runtime_endpoint_arn => { kind: :property, name: "attrAgentRuntimeEndpointArn", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :attr_last_updated_at => { kind: :property, name: "attrLastUpdatedAt", is_optional: false },
    :attr_live_version => { kind: :property, name: "attrLiveVersion", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_target_version => { kind: :property, name: "attrTargetVersion", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :runtime_endpoint_ref => { kind: :property, name: "runtimeEndpointRef", is_optional: false },
    :agent_runtime_id => { kind: :property, name: "agentRuntimeId", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :agent_runtime_version => { kind: :property, name: "agentRuntimeVersion", is_optional: true },
    :description => { kind: :property, name: "description", 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.



365
366
367
368
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 365

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:



377
378
379
380
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 377

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:



387
388
389
390
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 387

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.



398
399
400
401
402
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 398

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.


455
456
457
458
459
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 455

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.



465
466
467
468
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 465

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.



477
478
479
480
481
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 477

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_idString

The agent runtime ID.

Returns:

  • (String)


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

def agent_runtime_id()
  jsii_get_property("agentRuntimeId")
end

#agent_runtime_id=(value) ⇒ Object



276
277
278
279
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 276

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

#agent_runtime_versionString?

The version of the agent.

Returns:

  • (String, nil)


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

def agent_runtime_version()
  jsii_get_property("agentRuntimeVersion")
end

#agent_runtime_version=(value) ⇒ Object



300
301
302
303
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 300

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



490
491
492
493
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 490

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:



512
513
514
515
516
517
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 512

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_arnString

The Amazon Resource Name (ARN) of the runtime agent.

Returns:

  • (String)


195
196
197
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 195

def attr_agent_runtime_arn()
  jsii_get_property("attrAgentRuntimeArn")
end

#attr_agent_runtime_endpoint_arnString

The endpoint Amazon Resource Name (ARN).

Returns:

  • (String)


202
203
204
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 202

def attr_agent_runtime_endpoint_arn()
  jsii_get_property("attrAgentRuntimeEndpointArn")
end

#attr_created_atString

The time at which the endpoint was created.

Returns:

  • (String)


209
210
211
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 209

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reasonString

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

Returns:

  • (String)


216
217
218
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 216

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_idString

The ID of the runtime endpoint.

Returns:

  • (String)


223
224
225
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 223

def attr_id()
  jsii_get_property("attrId")
end

#attr_last_updated_atString

The time at which the endpoint was last updated.

Returns:

  • (String)


230
231
232
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 230

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_live_versionString

The live version for the runtime endpoint.

Returns:

  • (String)


237
238
239
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 237

def attr_live_version()
  jsii_get_property("attrLiveVersion")
end

#attr_statusString

The status of the runtime endpoint.

Returns:

  • (String)


244
245
246
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 244

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_target_versionString

The target version.

Returns:

  • (String)


251
252
253
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 251

def attr_target_version()
  jsii_get_property("attrTargetVersion")
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



258
259
260
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 258

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_optionsAWSCDK::ICfnResourceOptions

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



141
142
143
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 141

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


146
147
148
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 146

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


521
522
523
524
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 521

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


151
152
153
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 151

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


158
159
160
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 158

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


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

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

Contains information about an agent runtime endpoint.

Returns:

  • (String, nil)


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



312
313
314
315
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 312

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

#envAWSCDK::Interfaces::ResourceEnvironment



163
164
165
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 163

def env()
  jsii_get_property("env")
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:



534
535
536
537
538
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 534

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.



545
546
547
548
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 545

def (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:



615
616
617
618
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 615

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)


115
116
117
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 115

def logical_id()
  jsii_get_property("logicalId")
end

#nameString

The name of the AgentCore Runtime endpoint.

Returns:

  • (String)


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



288
289
290
291
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 288

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)


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

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:



556
557
558
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 556

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:



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

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.



356
357
358
359
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 356

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)


134
135
136
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 134

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:



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

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


581
582
583
584
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 581

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:



591
592
593
594
595
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 591

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

#runtime_endpoint_refAWSCDK::Interfaces::AWSBedrockagentcore::RuntimeEndpointReference

A reference to a RuntimeEndpoint resource.



265
266
267
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 265

def runtime_endpoint_ref()
  jsii_get_property("runtimeEndpointRef")
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.



600
601
602
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 600

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:



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

def stack()
  jsii_get_property("stack")
end

#tagsHash{String => String}?

The tags for the AgentCore Runtime endpoint.

Returns:

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


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

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



324
325
326
327
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 324

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



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

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


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

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


181
182
183
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 181

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


606
607
608
609
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 606

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)


345
346
347
348
349
350
# File 'bedrock_agent_core/cfn_runtime_endpoint.rb', line 345

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