Class: AWSCDK::BedrockAgentCore::RuntimeEndpointProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
bedrock_agent_core/runtime_endpoint_props.rb

Overview

Properties for creating a Bedrock Agent Core Runtime Endpoint resource.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(agent_runtime_id:, agent_runtime_version: nil, description: nil, endpoint_name: nil, tags: nil) ⇒ RuntimeEndpointProps

Returns a new instance of RuntimeEndpointProps.

Parameters:

  • agent_runtime_id (String) —

    The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]0,99-[a-zA-Z0-9]10$.

  • agent_runtime_version (String, nil) (defaults to: nil) —

    The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.

  • description (String, nil) (defaults to: nil) —

    Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.

  • endpoint_name (String, nil) (defaults to: nil) —

    The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]0,47$.

  • tags (Hash{String => String}, nil) (defaults to: nil) —

    Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.



12
13
14
15
16
17
18
19
20
21
22
23
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 12

def initialize(agent_runtime_id:, agent_runtime_version: nil, description: nil, endpoint_name: nil, tags: nil)
  @agent_runtime_id = agent_runtime_id
  Jsii::Type.check_type(@agent_runtime_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentRuntimeId")
  @agent_runtime_version = agent_runtime_version
  Jsii::Type.check_type(@agent_runtime_version, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "agentRuntimeVersion") unless @agent_runtime_version.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @endpoint_name = endpoint_name
  Jsii::Type.check_type(@endpoint_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "endpointName") unless @endpoint_name.nil?
  @tags = tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless @tags.nil?
end

Instance Attribute Details

#agent_runtime_id ⇒ String (readonly)

The ID of the agent runtime to associate with this endpoint This is the unique identifier of the runtime resource Pattern: ^[a-zA-Z][a-zA-Z0-9_]0,99-[a-zA-Z0-9]10$.

Returns:

  • (String) 


28
29
30
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 28

def agent_runtime_id
  @agent_runtime_id
end

#agent_runtime_version ⇒ String? (readonly)

Note:

Default: "1"

The version of the agent runtime to use for this endpoint If not specified, the endpoint will point to version "1" of the runtime.

Pattern: ^([1-9][0-9]0,4)$

Returns:

  • (String, nil) 


35
36
37
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 35

def agent_runtime_version
  @agent_runtime_version
end

#description ⇒ String? (readonly)

Note:

Default: - No description

Optional description for the agent runtime endpoint Length Minimum: 1 , Maximum: 256.

Returns:

  • (String, nil) 


40
41
42
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 40

def description
  @description
end

#endpoint_name ⇒ String? (readonly)

Note:

Default: - auto generate

The name of the agent runtime endpoint Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]0,47$.

Returns:

  • (String, nil) 


45
46
47
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 45

def endpoint_name
  @endpoint_name
end

#tags ⇒ Hash{String => String}? (readonly)

Note:

Default: {} - no tags

Tags for the agent runtime endpoint A list of key:value pairs of tags to apply to this RuntimeEndpoint resource Pattern: ^[a-zA-Z0-9\s._:/=+@-]*$.

Returns:

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


50
51
52
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 50

def tags
  @tags
end

Class Method Details

.jsii_properties ⇒ Object 



52
53
54
55
56
57
58
59
60
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 52

def self.jsii_properties
  {
    :agent_runtime_id => "agentRuntimeId",
    :agent_runtime_version => "agentRuntimeVersion",
    :description => "description",
    :endpoint_name => "endpointName",
    :tags => "tags",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



62
63
64
65
66
67
68
69
70
71
72
 
# File 'bedrock_agent_core/runtime_endpoint_props.rb', line 62

def to_jsii
  result = {}
  result.merge!({
    "agentRuntimeId" => @agent_runtime_id,
    "agentRuntimeVersion" => @agent_runtime_version,
    "description" => @description,
    "endpointName" => @endpoint_name,
    "tags" => @tags,
  })
  result.compact
end