Skip to content
v2.275.0

CfnApiKeyCredentialProviderProps Struct ​

Properties for defining a CfnApiKeyCredentialProvider.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnApiKeyCredentialProviderProps: bedrockagentcore.CfnApiKeyCredentialProviderProps = {
  name: 'name',

  // the properties below are optional
  apiKey: 'apiKey',
  apiKeySecretConfig: {
    jsonKey: 'jsonKey',
    secretId: 'secretId',
  },
  apiKeySecretSource: 'apiKeySecretSource',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties ​

apiKeyoptionalstringapi_keyoptionalstrapiKeyoptionalStringApiKeyoptionalstringApiKeyoptional*string#
The API key to use for authentication.
apiKeySecretConfigoptionalIResolvable | CfnApiKeyCredentialProvider.SecretReferencePropertyapi_key_secret_configoptionaltyping.Union[IResolvable, SecretReferenceProperty]apiKeySecretConfigoptionalIResolvableApiKeySecretConfigoptionalIResolvableApiKeySecretConfigoptionalinterface{}#
A reference to a customer-provided secret stored in AWS Secrets Manager.
apiKeySecretSourceoptionalstringapi_key_secret_sourceoptionalstrapiKeySecretSourceoptionalStringApiKeySecretSourceoptionalstringApiKeySecretSourceoptional*string#
The source of the API key secret.

Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.

namestringnamestrnameStringNamestringName*stringrequired#
The name of the API key credential provider.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
Tags to assign to the API key credential provider.