interface ApiKeyAdditionalConfiguration 🔹

Language	Type name
.NET	`Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.ApiKeyAdditionalConfiguration`
Go	`github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#ApiKeyAdditionalConfiguration`
Java	`software.amazon.awscdk.services.bedrock.agentcore.alpha.ApiKeyAdditionalConfiguration`
Python	`aws_cdk.aws_bedrock_agentcore_alpha.ApiKeyAdditionalConfiguration`
TypeScript (source)	`@aws-cdk/aws-bedrock-agentcore-alpha` » `ApiKeyAdditionalConfiguration`

API Key additional configuration.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as bedrock_agentcore_alpha from '@aws-cdk/aws-bedrock-agentcore-alpha';
const apiKeyAdditionalConfiguration: bedrock_agentcore_alpha.ApiKeyAdditionalConfiguration = {
  credentialParameterName: 'credentialParameterName',
  credentialPrefix: 'credentialPrefix',
};

Properties

Name	Type	Description
credentialParameterName?🔹	`string`	The name of the credential parameter for the API key.
credentialPrefix?🔹	`string`	The prefix for the API key credential.

credentialParameterName?🔹

Type: string (optional, 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.

credentialPrefix?🔹

Type: string (optional, 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.