interface ApiKeyCredentialProviderProps 🔹

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

API key credential provider ARNs for gateway outbound auth (Token Vault identity).

Pass this to {@link GatewayCredentialProvider.fromApiKeyIdentityArn } or to {@link ApiKeyCredentialProviderConfiguration}.

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';

declare const apiKeyCredentialLocation: bedrock_agentcore_alpha.ApiKeyCredentialLocation;
const apiKeyCredentialProviderProps: bedrock_agentcore_alpha.ApiKeyCredentialProviderProps = {
  providerArn: 'providerArn',
  secretArn: 'secretArn',

  // the properties below are optional
  credentialLocation: apiKeyCredentialLocation,
};

Properties

Name	Type	Description
providerArn🔹	`string`	The API key credential provider ARN.
secretArn🔹	`string`	The ARN of the Secrets Manager secret containing the API key.
credentialLocation?🔹	`ApiKeyCredentialLocation`	The location of the API key credential.

providerArn🔹

Type: string

The API key credential provider ARN.

This is returned when creating the API key credential provider via Console or API. Format: arn:aws:bedrock-agentcore:region:account:token-vault/id/apikeycredentialprovider/name

secretArn🔹

Type: string

The ARN of the Secrets Manager secret containing the API key.

This is returned when creating the API key credential provider via Console or API. Format: arn:aws:secretsmanager:region:account:secret:name

credentialLocation?🔹

Type: ApiKeyCredentialLocation (optional, default: HEADER)

The location of the API key credential.

This field specifies where in the request the API key should be placed.

AWS CDK