ApiKeyCredentialProvider - Amazon Bedrock AgentCore Control

ApiKeyCredentialProvider

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

Contents

providerArn

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

Type: String

Pattern: arn:([^:]*):([^:]*):([^:]*):([0-9]{12})?:(.+)

Required: Yes

credentialLocation

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

Type: String

Valid Values: HEADER | QUERY_PARAMETER

Required: No

credentialParameterName

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

Type: String

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

Required: No

credentialPrefix

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

Type: String

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

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: