ApiKeyCredentialProviderResourceProps

class aws_cdk.aws_bedrock_agentcore_alpha.ApiKeyCredentialProviderResourceProps(*, api_key=None, api_key_credential_provider_name=None, tags=None)

Bases: object

(experimental) Properties for a new {@link ApiKeyCredentialProvider} (Token Vault resource).

Parameters:

  • api_key (Optional[SecretValue]) – (experimental) The API key value. 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. Default: - no key in template (provider may still be created depending on service behavior)

  • api_key_credential_provider_name (Optional[str]) – (experimental) Name of the credential provider. Default: a name generated by CDK

  • tags (Optional[Mapping[str, str]]) – (experimental) Tags for this credential provider. Default: - no tags

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
import aws_cdk as cdk

# secret_value: cdk.SecretValue

api_key_credential_provider_resource_props = bedrock_agentcore_alpha.ApiKeyCredentialProviderResourceProps(
    api_key=secret_value,
    api_key_credential_provider_name="apiKeyCredentialProviderName",
    tags={
        "tags_key": "tags"
    }
)

Attributes

api_key

(experimental) The API key value.

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.

Default:

  • no key in template (provider may still be created depending on service behavior)

Stability:

experimental

api_key_credential_provider_name

(experimental) Name of the credential provider.

Default:

a name generated by CDK

Stability:

experimental

tags

(experimental) Tags for this credential provider.

Default:

  • no tags

Stability:

experimental