Class: AWSCDK::BedrockAgentCore::APIGatewayTargetConfigurationProps

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

Overview

Properties for creating an API Gateway target configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_gateway_tool_configuration:, rest_api:, metadata_configuration: nil, stage: nil) ⇒ APIGatewayTargetConfigurationProps

Returns a new instance of APIGatewayTargetConfigurationProps.

Parameters:



11
12
13
14
15
16
17
18
19
20
 
# File 'bedrock_agent_core/api_gateway_target_configuration_props.rb', line 11

def initialize(api_gateway_tool_configuration:, rest_api:, metadata_configuration: nil, stage: nil)
  @api_gateway_tool_configuration = api_gateway_tool_configuration.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::APIGatewayToolConfiguration.new(**api_gateway_tool_configuration.transform_keys(&:to_sym)) : api_gateway_tool_configuration
  Jsii::Type.check_type(@api_gateway_tool_configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlHYXRld2F5VG9vbENvbmZpZ3VyYXRpb24ifQ==")), "apiGatewayToolConfiguration")
  @rest_api = rest_api
  Jsii::Type.check_type(@rest_api, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBpZ2F0ZXdheS5JUmVzdEFwaSJ9")), "restApi")
  @metadata_configuration = metadata_configuration.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::MetadataConfiguration.new(**metadata_configuration.transform_keys(&:to_sym)) : metadata_configuration
  Jsii::Type.check_type(@metadata_configuration, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5NZXRhZGF0YUNvbmZpZ3VyYXRpb24ifQ==")), "metadataConfiguration") unless @metadata_configuration.nil?
  @stage = stage
  Jsii::Type.check_type(@stage, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "stage") unless @stage.nil?
end

Instance Attribute Details

#api_gateway_tool_configuration ⇒ AWSCDK::BedrockAgentCore::APIGatewayToolConfiguration (readonly)

Tool configuration defining which operations to expose.

Returns:



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

def api_gateway_tool_configuration
  @api_gateway_tool_configuration
end

#metadata_configuration ⇒ AWSCDK::BedrockAgentCore::MetadataConfiguration? (readonly)

Note:

Default: - No metadata configuration

Metadata configuration for passing headers and query parameters Allows you to pass additional context through headers and query parameters.

Returns:



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

def metadata_configuration
  @metadata_configuration
end

#rest_api ⇒ AWSCDK::APIGateway::IRestAPI (readonly)

The REST API to integrate with Must be in the same account and region as the gateway.

Returns:



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

def rest_api
  @rest_api
end

#stage ⇒ String? (readonly)

Note:

Default: - Uses the deployment stage from the RestApi (restApi.deploymentStage.stageName)

The stage name of the REST API.

Returns:

  • (String, nil) 


39
40
41
 
# File 'bedrock_agent_core/api_gateway_target_configuration_props.rb', line 39

def stage
  @stage
end

Class Method Details

.jsii_properties ⇒ Object 



41
42
43
44
45
46
47
48
 
# File 'bedrock_agent_core/api_gateway_target_configuration_props.rb', line 41

def self.jsii_properties
  {
    :api_gateway_tool_configuration => "apiGatewayToolConfiguration",
    :rest_api => "restApi",
    :metadata_configuration => "metadataConfiguration",
    :stage => "stage",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



50
51
52
53
54
55
56
57
58
59
 
# File 'bedrock_agent_core/api_gateway_target_configuration_props.rb', line 50

def to_jsii
  result = {}
  result.merge!({
    "apiGatewayToolConfiguration" => @api_gateway_tool_configuration,
    "restApi" => @rest_api,
    "metadataConfiguration" => @metadata_configuration,
    "stage" => @stage,
  })
  result.compact
end