Class: AWSCDK::BedrockAgentCore::GatewayTargetSmithyProps

Inherits:
GatewayTargetCommonProps
  • Object
show all
Defined in:
bedrock_agent_core/gateway_target_smithy_props.rb

Overview

Properties for creating a Smithy-based Gateway Target.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(description: nil, gateway_target_name: nil, gateway:, smithy_model:, credential_provider_configurations: nil) ⇒ GatewayTargetSmithyProps

Returns a new instance of GatewayTargetSmithyProps.

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$.

  • gateway (AWSCDK::BedrockAgentCore::IGateway) —

    The gateway this target belongs to.

  • smithy_model (AWSCDK::BedrockAgentCore::APISchema) —

    The Smithy model defining the API.

  • credential_provider_configurations (Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>, nil) (defaults to: nil) —

    Credential providers for authentication Smithy targets only support IAM role authentication.



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

def initialize(description: nil, gateway_target_name: nil, gateway:, smithy_model:, credential_provider_configurations: 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?
  @gateway = gateway
  Jsii::Type.check_type(@gateway, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5JR2F0ZXdheSJ9")), "gateway")
  @smithy_model = smithy_model
  Jsii::Type.check_type(@smithy_model, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlTY2hlbWEifQ==")), "smithyModel")
  @credential_provider_configurations = credential_provider_configurations
  Jsii::Type.check_type(@credential_provider_configurations, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLklDcmVkZW50aWFsUHJvdmlkZXJDb25maWcifSwia2luZCI6ImFycmF5In19")), "credentialProviderConfigurations") unless @credential_provider_configurations.nil?
end

Instance Attribute Details

#credential_provider_configurations ⇒ Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>? (readonly)

Note:

Default: - [GatewayCredentialProvider.fromIamRole()]

Credential providers for authentication Smithy targets only support IAM role authentication.

Returns:



47
48
49
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 47

def credential_provider_configurations
  @credential_provider_configurations
end

#description ⇒ String? (readonly)

Note:

Default: - No description

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

Returns:

  • (String, nil) 


29
30
31
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 29

def description
  @description
end

#gateway ⇒ AWSCDK::BedrockAgentCore::IGateway (readonly)

The gateway this target belongs to.

Returns:



38
39
40
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 38

def gateway
  @gateway
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) 


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

def gateway_target_name
  @gateway_target_name
end

#smithy_model ⇒ AWSCDK::BedrockAgentCore::APISchema (readonly)

The Smithy model defining the API.

Returns:



42
43
44
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 42

def smithy_model
  @smithy_model
end

Class Method Details

.jsii_properties ⇒ Object 



49
50
51
52
53
54
55
56
57
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 49

def self.jsii_properties
  {
    :description => "description",
    :gateway_target_name => "gatewayTargetName",
    :gateway => "gateway",
    :smithy_model => "smithyModel",
    :credential_provider_configurations => "credentialProviderConfigurations",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'bedrock_agent_core/gateway_target_smithy_props.rb', line 59

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "description" => @description,
    "gatewayTargetName" => @gateway_target_name,
    "gateway" => @gateway,
    "smithyModel" => @smithy_model,
    "credentialProviderConfigurations" => @credential_provider_configurations,
  })
  result.compact
end