Class: AWSCDK::BedrockAgentCore::APIKeyCredentialLocation

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

Overview

API Key location within the request.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(*args) ⇒ APIKeyCredentialLocation

Returns a new instance of APIKeyCredentialLocation.

Raises:

  • (NoMethodError) 


8
9
10
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 8

def initialize(*args)
  raise NoMethodError, "aws-cdk-lib.aws_bedrockagentcore.ApiKeyCredentialLocation does not have a visible constructor; use the provided factory methods"
end

Class Method Details

.header(config = nil) ⇒ AWSCDK::BedrockAgentCore::APIKeyCredentialLocation

Create a header-based API key credential location.

Parameters:

Returns:

  • (AWSCDK::BedrockAgentCore::APIKeyCredentialLocation) —

    ApiKeyCredentialLocation configured for header placement



24
25
26
27
28
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 24

def self.header(config = nil)
  config = config.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::APIKeyAdditionalConfiguration.new(**config.transform_keys(&:to_sym)) : config
  Jsii::Type.check_type(config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlLZXlBZGRpdGlvbmFsQ29uZmlndXJhdGlvbiJ9")), "config") unless config.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.ApiKeyCredentialLocation", "header", [config])
end

.jsii_overridable_methods ⇒ Object 



12
13
14
15
16
17
18
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 12

def self.jsii_overridable_methods
  {
    :credential_location_type => { kind: :property, name: "credentialLocationType", is_optional: false },
    :credential_parameter_name => { kind: :property, name: "credentialParameterName", is_optional: false },
    :credential_prefix => { kind: :property, name: "credentialPrefix", is_optional: true },
  }
end

.query_parameter(config = nil) ⇒ AWSCDK::BedrockAgentCore::APIKeyCredentialLocation

Create a query parameter-based API key credential location.

Parameters:

Returns:

  • (AWSCDK::BedrockAgentCore::APIKeyCredentialLocation) —

    ApiKeyCredentialLocation configured for query parameter placement



34
35
36
37
38
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 34

def self.query_parameter(config = nil)
  config = config.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::APIKeyAdditionalConfiguration.new(**config.transform_keys(&:to_sym)) : config
  Jsii::Type.check_type(config, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5BcGlLZXlBZGRpdGlvbmFsQ29uZmlndXJhdGlvbiJ9")), "config") unless config.nil?
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.ApiKeyCredentialLocation", "queryParameter", [config])
end

Instance Method Details

#credential_location_type ⇒ String

The type of credential location (HEADER or QUERY_PARAMETER).

Returns:

  • (String) 


43
44
45
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 43

def credential_location_type()
  jsii_get_property("credentialLocationType")
end

#credential_parameter_name ⇒ String

The name of the credential parameter.

Returns:

  • (String) 


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

def credential_parameter_name()
  jsii_get_property("credentialParameterName")
end

#credential_prefix ⇒ String?

The prefix for the credential value.

Returns:

  • (String, nil) 


57
58
59
 
# File 'bedrock_agent_core/api_key_credential_location.rb', line 57

def credential_prefix()
  jsii_get_property("credentialPrefix")
end