Class: AWSCDK::BedrockAgentCore::APIKeyAdditionalConfiguration

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

Overview

API Key additional configuration.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credential_parameter_name: nil, credential_prefix: nil) ⇒ APIKeyAdditionalConfiguration

Returns a new instance of APIKeyAdditionalConfiguration.

Parameters:

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

    The name of the credential parameter for the API key.

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

    The prefix for the API key credential.



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

def initialize(credential_parameter_name: nil, credential_prefix: nil)
  @credential_parameter_name = credential_parameter_name
  Jsii::Type.check_type(@credential_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialParameterName") unless @credential_parameter_name.nil?
  @credential_prefix = credential_prefix
  Jsii::Type.check_type(@credential_prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "credentialPrefix") unless @credential_prefix.nil?
end

Instance Attribute Details

#credential_parameter_name ⇒ String? (readonly)

Note:

Default: - 'Authorization' for HEADER, 'api_key' for QUERY_PARAMETER

The name of the credential parameter for the API key.

This parameter name is used when sending the API key to the target endpoint.

Length Constraints: Minimum length of 1. Maximum length of 64.

Returns:

  • (String, nil) 


24
25
26
 
# File 'bedrock_agent_core/api_key_additional_configuration.rb', line 24

def credential_parameter_name
  @credential_parameter_name
end

#credential_prefix ⇒ String? (readonly)

Note:

Default: - 'Bearer ' for HEADER, no prefix for QUERY_PARAMETER

The prefix for the API key credential.

This prefix is added to the API key when sending it to the target endpoint.

Length Constraints: Minimum length of 1. Maximum length of 64.

Returns:

  • (String, nil) 


33
34
35
 
# File 'bedrock_agent_core/api_key_additional_configuration.rb', line 33

def credential_prefix
  @credential_prefix
end

Class Method Details

.jsii_properties ⇒ Object 



35
36
37
38
39
40
 
# File 'bedrock_agent_core/api_key_additional_configuration.rb', line 35

def self.jsii_properties
  {
    :credential_parameter_name => "credentialParameterName",
    :credential_prefix => "credentialPrefix",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



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

def to_jsii
  result = {}
  result.merge!({
    "credentialParameterName" => @credential_parameter_name,
    "credentialPrefix" => @credential_prefix,
  })
  result.compact
end