Class: Aws::BedrockAgentCoreControl::Types::ApiKeyCredentialProvider

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb

Overview

An API key credential provider for gateway authentication. This structure contains the configuration for authenticating with the target endpoint using an API key.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#credential_location ⇒ String

The location of the API key credential. This field specifies where in the request the API key should be placed.

Returns:

  • (String) 


384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 384

class ApiKeyCredentialProvider < Struct.new(
  :provider_arn,
  :credential_parameter_name,
  :credential_prefix,
  :credential_location)
  SENSITIVE = []
  include Aws::Structure
end

#credential_parameter_name ⇒ String

The name of the credential parameter for the API key. This parameter name is used when sending the API key to the target endpoint.

Returns:

  • (String) 


384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 384

class ApiKeyCredentialProvider < Struct.new(
  :provider_arn,
  :credential_parameter_name,
  :credential_prefix,
  :credential_location)
  SENSITIVE = []
  include Aws::Structure
end

#credential_prefix ⇒ String

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

Returns:

  • (String) 


384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 384

class ApiKeyCredentialProvider < Struct.new(
  :provider_arn,
  :credential_parameter_name,
  :credential_prefix,
  :credential_location)
  SENSITIVE = []
  include Aws::Structure
end

#provider_arn ⇒ String

The Amazon Resource Name (ARN) of the API key credential provider. This ARN identifies the provider in Amazon Web Services.

Returns:

  • (String) 


384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 384

class ApiKeyCredentialProvider < Struct.new(
  :provider_arn,
  :credential_parameter_name,
  :credential_prefix,
  :credential_location)
  SENSITIVE = []
  include Aws::Structure
end