Class: Aws::BedrockAgentCoreControl::Types::ApiKeyCredentialProvider
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockAgentCoreControl::Types::ApiKeyCredentialProvider
- 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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#credential_location ⇒ String
The location of the API key credential.
-
#credential_parameter_name ⇒ String
The name of the credential parameter for the API key.
-
#credential_prefix ⇒ String
The prefix for the API key credential.
-
#provider_arn ⇒ String
The Amazon Resource Name (ARN) of the API key credential provider.
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.
184 185 186 187 188 189 190 191 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 184 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.
184 185 186 187 188 189 190 191 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 184 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.
184 185 186 187 188 189 190 191 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 184 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.
184 185 186 187 188 189 190 191 |
# File 'gems/aws-sdk-bedrockagentcorecontrol/lib/aws-sdk-bedrockagentcorecontrol/types.rb', line 184 class ApiKeyCredentialProvider < Struct.new( :provider_arn, :credential_parameter_name, :credential_prefix, :credential_location) SENSITIVE = [] include Aws::Structure end |