interface CfnApiKeyCredentialProviderProps

Language	Type name
.NET	`Amazon.CDK.AWS.BedrockAgentCore.CfnApiKeyCredentialProviderProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnApiKeyCredentialProviderProps`
Java	`software.amazon.awscdk.services.bedrockagentcore.CfnApiKeyCredentialProviderProps`
Python	`aws_cdk.aws_bedrockagentcore.CfnApiKeyCredentialProviderProps`
TypeScript	`aws-cdk-lib` » `aws_bedrockagentcore` » `CfnApiKeyCredentialProviderProps`

Properties for defining a CfnApiKeyCredentialProvider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html

Example

// 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',
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
name	`string`	The name of the API key credential provider.
apiKey?	`string`	The API key to use for authentication.
tags?	`CfnTag[]`	Tags to assign to the API key credential provider.

name

Type: string

The name of the API key credential provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-name

apiKey?

Type: string (optional)

The API key to use for authentication.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-apikey

tags?

Type: CfnTag[] (optional)

Tags to assign to the API key credential provider.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html#cfn-bedrockagentcore-apikeycredentialprovider-tags

AWS CDK