CfnGuardrailMixinProps

class aws_cdk.mixins_preview.aws_bedrock.mixins.CfnGuardrailMixinProps(*, automated_reasoning_policy_config=None, blocked_input_messaging=None, blocked_outputs_messaging=None, content_policy_config=None, contextual_grounding_policy_config=None, cross_region_config=None, description=None, kms_key_arn=None, name=None, sensitive_information_policy_config=None, tags=None, topic_policy_config=None, word_policy_config=None)

Bases: object

Properties for CfnGuardrailPropsMixin.

Parameters:

automated_reasoning_policy_config (Union[IResolvable, AutomatedReasoningPolicyConfigProperty, Dict[str, Any], None]) – Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
blocked_input_messaging (Optional[str]) – The message to return when the guardrail blocks a prompt.
blocked_outputs_messaging (Optional[str]) – The message to return when the guardrail blocks a model response.
content_policy_config (Union[IResolvable, ContentPolicyConfigProperty, Dict[str, Any], None]) – The content filter policies to configure for the guardrail.
contextual_grounding_policy_config (Union[IResolvable, ContextualGroundingPolicyConfigProperty, Dict[str, Any], None]) – Contextual grounding policy config for a guardrail.
cross_region_config (Union[IResolvable, GuardrailCrossRegionConfigProperty, Dict[str, Any], None]) – The system-defined guardrail profile that you’re using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases. For more information, see the Amazon Bedrock User Guide .
description (Optional[str]) – A description of the guardrail.
kms_key_arn (Optional[str]) – The ARN of the AWS key that you use to encrypt the guardrail.
name (Optional[str]) – The name of the guardrail.
sensitive_information_policy_config (Union[IResolvable, SensitiveInformationPolicyConfigProperty, Dict[str, Any], None]) – The sensitive information policy to configure for the guardrail.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – The tags that you want to attach to the guardrail.
topic_policy_config (Union[IResolvable, TopicPolicyConfigProperty, Dict[str, Any], None]) – The topic policies to configure for the guardrail.
word_policy_config (Union[IResolvable, WordPolicyConfigProperty, Dict[str, Any], None]) – The word policy you configure for the guardrail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.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.mixins_preview.aws_bedrock import mixins as bedrock_mixins

cfn_guardrail_mixin_props = bedrock_mixins.CfnGuardrailMixinProps(
    automated_reasoning_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty(
        confidence_threshold=123,
        policies=["policies"]
    ),
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",
    content_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.ContentPolicyConfigProperty(
        content_filters_tier_config=bedrock_mixins.CfnGuardrailPropsMixin.ContentFiltersTierConfigProperty(
            tier_name="tierName"
        ),
        filters_config=[bedrock_mixins.CfnGuardrailPropsMixin.ContentFilterConfigProperty(
            input_action="inputAction",
            input_enabled=False,
            input_modalities=["inputModalities"],
            input_strength="inputStrength",
            output_action="outputAction",
            output_enabled=False,
            output_modalities=["outputModalities"],
            output_strength="outputStrength",
            type="type"
        )]
    ),
    contextual_grounding_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty(
        filters_config=[bedrock_mixins.CfnGuardrailPropsMixin.ContextualGroundingFilterConfigProperty(
            action="action",
            enabled=False,
            threshold=123,
            type="type"
        )]
    ),
    cross_region_config=bedrock_mixins.CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty(
        guardrail_profile_arn="guardrailProfileArn"
    ),
    description="description",
    kms_key_arn="kmsKeyArn",
    name="name",
    sensitive_information_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty(
        pii_entities_config=[bedrock_mixins.CfnGuardrailPropsMixin.PiiEntityConfigProperty(
            action="action",
            input_action="inputAction",
            input_enabled=False,
            output_action="outputAction",
            output_enabled=False,
            type="type"
        )],
        regexes_config=[bedrock_mixins.CfnGuardrailPropsMixin.RegexConfigProperty(
            action="action",
            description="description",
            input_action="inputAction",
            input_enabled=False,
            name="name",
            output_action="outputAction",
            output_enabled=False,
            pattern="pattern"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    topic_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.TopicPolicyConfigProperty(
        topics_config=[bedrock_mixins.CfnGuardrailPropsMixin.TopicConfigProperty(
            definition="definition",
            examples=["examples"],
            input_action="inputAction",
            input_enabled=False,
            name="name",
            output_action="outputAction",
            output_enabled=False,
            type="type"
        )],
        topics_tier_config=bedrock_mixins.CfnGuardrailPropsMixin.TopicsTierConfigProperty(
            tier_name="tierName"
        )
    ),
    word_policy_config=bedrock_mixins.CfnGuardrailPropsMixin.WordPolicyConfigProperty(
        managed_word_lists_config=[bedrock_mixins.CfnGuardrailPropsMixin.ManagedWordsConfigProperty(
            input_action="inputAction",
            input_enabled=False,
            output_action="outputAction",
            output_enabled=False,
            type="type"
        )],
        words_config=[bedrock_mixins.CfnGuardrailPropsMixin.WordConfigProperty(
            input_action="inputAction",
            input_enabled=False,
            output_action="outputAction",
            output_enabled=False,
            text="text"
        )]
    )
)

Attributes

automated_reasoning_policy_config

Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig

blocked_input_messaging

The message to return when the guardrail blocks a prompt.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging

blocked_outputs_messaging

The message to return when the guardrail blocks a model response.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging

content_policy_config

The content filter policies to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig

contextual_grounding_policy_config

Contextual grounding policy config for a guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig

cross_region_config

The system-defined guardrail profile that you’re using with your guardrail.

Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.

For more information, see the Amazon Bedrock User Guide .