CfnApiKeyCredentialProviderProps

class aws_cdk.aws_bedrockagentcore.CfnApiKeyCredentialProviderProps(*, name, api_key=None, tags=None)

Bases: object

Properties for defining a CfnApiKeyCredentialProvider.

Parameters:

  • name (str) – The name of the API key credential provider.

  • api_key (Optional[str]) – The API key to use for authentication.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags to assign to the API key credential provider.

See:

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

ExampleMetadata:

fixture=_generated

Example:

from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_bedrockagentcore as bedrockagentcore

cfn_api_key_credential_provider_props = bedrockagentcore.CfnApiKeyCredentialProviderProps(
    name="name",

    # the properties below are optional
    api_key="apiKey",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Attributes

api_key

The API key to use for authentication.

See:

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

name

The name of the API key credential provider.

See:

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

tags

Tags to assign to the API key credential provider.

See:

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