Class: AWSCDK::BedrockAgentCore::GatewayTargetCommonProps

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

Overview

Common properties for all Gateway Target types.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, gateway_target_name: nil) ⇒ GatewayTargetCommonProps

Returns a new instance of GatewayTargetCommonProps.

Parameters:

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

    Optional description for the gateway target The description can have up to 200 characters.

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

    The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?)1,100$.



9
10
11
12
13
14
 
# File 'bedrock_agent_core/gateway_target_common_props.rb', line 9

def initialize(description: nil, gateway_target_name: nil)
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @gateway_target_name = gateway_target_name
  Jsii::Type.check_type(@gateway_target_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "gatewayTargetName") unless @gateway_target_name.nil?
end

Instance Attribute Details

#description ⇒ String? (readonly)

Note:

Default: - No description

Optional description for the gateway target The description can have up to 200 characters.

Returns:

  • (String, nil) 


20
21
22
 
# File 'bedrock_agent_core/gateway_target_common_props.rb', line 20

def description
  @description
end

#gateway_target_name ⇒ String? (readonly)

Note:

Default: - auto generate

The name of the gateway target The name must be unique within the gateway Pattern: ^([0-9a-zA-Z][-]?)1,100$.

Returns:

  • (String, nil) 


25
26
27
 
# File 'bedrock_agent_core/gateway_target_common_props.rb', line 25

def gateway_target_name
  @gateway_target_name
end

Class Method Details

.jsii_properties ⇒ Object 



27
28
29
30
31
32
 
# File 'bedrock_agent_core/gateway_target_common_props.rb', line 27

def self.jsii_properties
  {
    :description => "description",
    :gateway_target_name => "gatewayTargetName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



34
35
36
37
38
39
40
41
 
# File 'bedrock_agent_core/gateway_target_common_props.rb', line 34

def to_jsii
  result = {}
  result.merge!({
    "description" => @description,
    "gatewayTargetName" => @gateway_target_name,
  })
  result.compact
end