Experimental
@aws-cdk/aws-bedrock-agentcore-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.
ApiKeyCredentialProviderResourceProps Struct
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
apiKeyoptionalSecretValueapi_keyoptionalSecretValueapiKeyoptionalSecretValueApiKeyoptionalSecretValueApiKeyoptionalSecretValue#Default: no key in template (provider may still be created depending on service behavior)
notes
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.
apiKeyCredentialProviderNameoptionalstringapi_key_credential_provider_nameoptionalstrapiKeyCredentialProviderNameoptionalStringApiKeyCredentialProviderNameoptionalstringApiKeyCredentialProviderNameoptional*string#Default: a name generated by CDK
tagsoptional{ [key: string]: string }tagsoptionaltyping.Mapping[str, str]tagsoptionalMap<String, String>TagsoptionalIDictionary<string, string>Tagsoptional*map[string]*string#Default: no tags