CfnApiKeyCredentialProviderProps

class aws_cdk.aws_bedrockagentcore.CfnApiKeyCredentialProviderProps(*, name, api_key=None, api_key_secret_config=None, api_key_secret_source=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.
api_key_secret_config (Union[IResolvable, SecretReferenceProperty, Dict[str, Any], None]) – A reference to a customer-provided secret stored in AWS Secrets Manager.
api_key_secret_source (Optional[str]) – The source of the API key secret. Use MANAGED for service-managed secrets or EXTERNAL for customer-provided secrets.
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",
    api_key_secret_config=bedrockagentcore.CfnApiKeyCredentialProvider.SecretReferenceProperty(
        json_key="jsonKey",
        secret_id="secretId"
    ),
    api_key_secret_source="apiKeySecretSource",
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)