Class: AWSCDK::BedrockAgentCore::RuntimeEndpointBase

Inherits:
Resource
  • Object
show all
Includes:
IRuntimeEndpoint
Defined in:
bedrock_agent_core/runtime_endpoint_base.rb

Overview

Base class for Runtime Endpoint.

Direct Known Subclasses

RuntimeEndpoint

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of RuntimeEndpointBase.

Parameters:



12
13
14
15
16
17
18
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 12

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 20

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :agent_runtime_arn => { kind: :property, name: "agentRuntimeArn", is_optional: false },
    :agent_runtime_endpoint_arn => { kind: :property, name: "agentRuntimeEndpointArn", is_optional: false },
    :endpoint_name => { kind: :property, name: "endpointName", is_optional: false },
    :runtime_endpoint_ref => { kind: :property, name: "runtimeEndpointRef", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :live_version => { kind: :property, name: "liveVersion", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :target_version => { kind: :property, name: "targetVersion", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
  }
end

Instance Method Details

#agent_runtime_arn ⇒ String

The ARN of the parent agent runtime.

Returns:

  • (String) 


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

def agent_runtime_arn()
  jsii_get_property("agentRuntimeArn")
end

#agent_runtime_endpoint_arn ⇒ String

The ARN of the runtime endpoint resource.

Returns:

  • (String) 


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

def agent_runtime_endpoint_arn()
  jsii_get_property("agentRuntimeEndpointArn")
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



184
185
186
187
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 184

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

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



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

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

#created_at ⇒ String?

When the endpoint was created.

Returns:

  • (String, nil) 


119
120
121
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 119

def created_at()
  jsii_get_property("createdAt")
end

#description ⇒ String?

The description of the runtime endpoint.

Returns:

  • (String, nil) 


126
127
128
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 126

def description()
  jsii_get_property("description")
end

#endpoint_name ⇒ String

The name of the runtime endpoint.

Returns:

  • (String) 


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

def endpoint_name()
  jsii_get_property("endpointName")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



63
64
65
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 63

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


207
208
209
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 207

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

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

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

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

Parameters:

  • arn_attr (String) —

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

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


221
222
223
224
225
226
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 221

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

#get_resource_name_attribute(name_attr) ⇒ String

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

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

Parameters:

  • name_attr (String) —

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

Returns:

  • (String) 


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

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

#live_version ⇒ String?

The live version of the agent runtime that is currently serving requests.

Returns:

  • (String, nil) 


133
134
135
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 133

def live_version()
  jsii_get_property("liveVersion")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


48
49
50
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 48

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

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

This value will resolve to one of the following:

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

Returns:

  • (String) 


77
78
79
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 77

def physical_name()
  jsii_get_property("physicalName")
end

#runtime_endpoint_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::RuntimeEndpointReference

A reference to a RuntimeEndpoint resource.

Returns:



112
113
114
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 112

def runtime_endpoint_ref()
  jsii_get_property("runtimeEndpointRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



84
85
86
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 84

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The current status of the runtime endpoint.

Returns:

  • (String, nil) 


140
141
142
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 140

def status()
  jsii_get_property("status")
end

#target_version ⇒ String?

The target version the endpoint is transitioning to (during updates).

Returns:

  • (String, nil) 


147
148
149
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 147

def target_version()
  jsii_get_property("targetVersion")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

def to_string()
  jsii_call_method("toString", [])
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) 


167
168
169
170
171
172
 
# File 'bedrock_agent_core/runtime_endpoint_base.rb', line 167

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