Module: AWSCDK::BedrockAgentCore::IRuntimeEndpoint

Includes:
IResource, Interfaces::AWSBedrockagentcore::IRuntimeEndpointRef
Included in:
RuntimeEndpointBase
Defined in:
bedrock_agent_core/i_runtime_endpoint.rb

Overview

Interface for Runtime Endpoint resources.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 134

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :runtime_endpoint_ref => { kind: :property, name: "runtimeEndpointRef", 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 },
    :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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
  }
end

Instance Method Details

#agent_runtime_arn ⇒ String

The ARN of the parent agent runtime.

Returns:

  • (String) 


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

def agent_runtime_arn()
  jsii_get_property("agentRuntimeArn")
end

#agent_runtime_endpoint_arn ⇒ String

The ARN of the runtime endpoint resource.

Examples:

"arn:aws:bedrock-agentcore:us-west-2:123456789012:agent-runtime-endpoint/endpoint-abc123"

Returns:

  • (String) 


57
58
59
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 57

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



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

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) 


71
72
73
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 71

def created_at()
  jsii_get_property("createdAt")
end

#description ⇒ String?

The description of the runtime endpoint.

Returns:

  • (String, nil) 


78
79
80
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 78

def description()
  jsii_get_property("description")
end

#endpoint_name ⇒ String

The name of the runtime endpoint.

Returns:

  • (String) 


64
65
66
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 64

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:



27
28
29
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 27

def env()
  jsii_get_property("env")
end

#live_version ⇒ String?

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

Returns:

  • (String, nil) 


85
86
87
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 85

def live_version()
  jsii_get_property("liveVersion")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 12

def node()
  jsii_get_property("node")
end

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

A reference to a RuntimeEndpoint resource.

Returns:



41
42
43
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 41

def runtime_endpoint_ref()
  jsii_get_property("runtimeEndpointRef")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 34

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The current status of the runtime endpoint.

Returns:

  • (String, nil) 


92
93
94
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 92

def status()
  jsii_get_property("status")
end

#target_version ⇒ String?

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

Returns:

  • (String, nil) 


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

def target_version()
  jsii_get_property("targetVersion")
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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



110
111
112
113
114
115
 
# File 'bedrock_agent_core/i_runtime_endpoint.rb', line 110

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