CfnApiKeyCredentialProviderPropsMixin

class aws_cdk.cfn_property_mixins.aws_bedrockagentcore.CfnApiKeyCredentialProviderPropsMixin(props, *, strategy=None)

Bases: Mixin

Resource Type definition for AWS::BedrockAgentCore::ApiKeyCredentialProvider.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-apikeycredentialprovider.html
CloudformationResource:: AWS::BedrockAgentCore::ApiKeyCredentialProvider
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

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

# merge_strategy: cdk.IMergeStrategy

cfn_api_key_credential_provider_props_mixin = bedrockagentcore.CfnApiKeyCredentialProviderPropsMixin(bedrockagentcore.CfnApiKeyCredentialProviderMixinProps(
    api_key="apiKey",
    api_key_secret_config=bedrockagentcore.CfnApiKeyCredentialProviderPropsMixin.SecretReferenceProperty(
        json_key="jsonKey",
        secret_id="secretId"
    ),
    api_key_secret_source="apiKeySecretSource",
    name="name",
    tags=[cdk.CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=merge_strategy
)

Create a mixin to apply properties to AWS::BedrockAgentCore::ApiKeyCredentialProvider.

Parameters:

props (Union[CfnApiKeyCredentialProviderMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[IMergeStrategy]) – Strategy for merging nested properties. Default: - PropertyMergeStrategy.combine()

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: None

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['apiKey', 'apiKeySecretConfig', 'apiKeySecretSource', 'name', 'tags']

Static Methods

classmethod is_mixin(x)

Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.

ApiKeySecretArnProperty

class CfnApiKeyCredentialProviderPropsMixin.ApiKeySecretArnProperty(*, secret_arn=None)

Bases: object

Contains information about the API key secret in AWS Secrets Manager.

Parameters:: secret_arn (Optional[str]) – The ARN of the secret in AWS Secrets Manager.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn.html
ExampleMetadata:: fixture=_generated

Example:

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

api_key_secret_arn_property = bedrockagentcore.CfnApiKeyCredentialProviderPropsMixin.ApiKeySecretArnProperty(
    secret_arn="secretArn"
)

Attributes

secret_arn

The ARN of the secret in AWS Secrets Manager.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-apikeysecretarn.html#cfn-bedrockagentcore-apikeycredentialprovider-apikeysecretarn-secretarn

SecretReferenceProperty

class CfnApiKeyCredentialProviderPropsMixin.SecretReferenceProperty(*, json_key=None, secret_id=None)

Bases: object

A reference to a customer-provided secret stored in AWS Secrets Manager.

Parameters:

json_key (Optional[str]) – The JSON key within the secret that contains the credential value.
secret_id (Optional[str]) – The ID or ARN of the secret in AWS Secrets Manager.

See:

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

ExampleMetadata:

fixture=_generated

Example:

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

secret_reference_property = bedrockagentcore.CfnApiKeyCredentialProviderPropsMixin.SecretReferenceProperty(
    json_key="jsonKey",
    secret_id="secretId"
)

Attributes

json_key

The JSON key within the secret that contains the credential value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-secretreference.html#cfn-bedrockagentcore-apikeycredentialprovider-secretreference-jsonkey

secret_id

The ID or ARN of the secret in AWS Secrets Manager.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-apikeycredentialprovider-secretreference.html#cfn-bedrockagentcore-apikeycredentialprovider-secretreference-secretid