interface ApiKeyCredentialProviderResourceProps 🔹

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

Properties for a new {@link ApiKeyCredentialProvider} (Token Vault resource).

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';
import * as cdk from 'aws-cdk-lib';

declare const secretValue: cdk.SecretValue;
const apiKeyCredentialProviderResourceProps: bedrock_agentcore_alpha.ApiKeyCredentialProviderResourceProps = {
  apiKey: secretValue,
  apiKeyCredentialProviderName: 'apiKeyCredentialProviderName',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
apiKey?🔹	`SecretValue`	The API key value.
apiKeyCredentialProviderName?🔹	`string`	Name of the credential provider.
tags?🔹	`{ [string]: string }`	Tags for this credential provider.

apiKey?🔹

Type: SecretValue (optional, default: no key in template (provider may still be created depending on service behavior))

The API key value.

NOTE: The API key will be included in the CloudFormation template as part of synthesis. The service stores the key in Secrets Manager after creation, but the value is visible in the template and deployment history. Use SecretValue.unsafePlainText() to explicitly acknowledge plaintext, or pass a reference from another construct to avoid embedding the literal value.

If omitted, you can supply the key through another mechanism supported by the service.

apiKeyCredentialProviderName?🔹

Type: string (optional, default: a name generated by CDK)

Name of the credential provider.

tags?🔹

Type: { [string]: string } (optional, default: no tags)

Tags for this credential provider.

AWS CDK