CfnAIGuardrailPropsMixin

class aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIGuardrailPropsMixin(props, *, strategy=None)

Bases: Mixin

Creates an Amazon Q in Connect AI Guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html
CloudformationResource:: AWS::Wisdom::AIGuardrail
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_wisdom import mixins as wisdom_mixins

cfn_aIGuardrail_props_mixin = wisdom_mixins.CfnAIGuardrailPropsMixin(wisdom_mixins.CfnAIGuardrailMixinProps(
    assistant_id="assistantId",
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",
    content_policy_config=wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(
        filters_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
            input_strength="inputStrength",
            output_strength="outputStrength",
            type="type"
        )]
    ),
    contextual_grounding_policy_config=wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(
        filters_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
            threshold=123,
            type="type"
        )]
    ),
    description="description",
    name="name",
    sensitive_information_policy_config=wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(
        pii_entities_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
            action="action",
            type="type"
        )],
        regexes_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
            action="action",
            description="description",
            name="name",
            pattern="pattern"
        )]
    ),
    tags={
        "tags_key": "tags"
    },
    topic_policy_config=wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(
        topics_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
            definition="definition",
            examples=["examples"],
            name="name",
            type="type"
        )]
    ),
    word_policy_config=wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(
        managed_word_lists_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
            type="type"
        )],
        words_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
            text="text"
        )]
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::Wisdom::AIGuardrail.

Parameters:

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

Methods

apply_to(construct)

Apply the mixin properties to the construct.

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

supports(construct)

Check if this mixin supports the given construct.

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

Attributes

CFN_PROPERTY_KEYS = ['assistantId', 'blockedInputMessaging', 'blockedOutputsMessaging', 'contentPolicyConfig', 'contextualGroundingPolicyConfig', 'description', 'name', 'sensitiveInformationPolicyConfig', 'tags', 'topicPolicyConfig', 'wordPolicyConfig']

Static Methods

classmethod is_mixin(x)

(experimental) 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.
Stability:: experimental

AIGuardrailContentPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(*, filters_config=None)

Bases: object

Content policy config for a guardrail.

Parameters:: filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContentFilterConfigProperty, Dict[str, Any]]], None]) – List of content filter configurations in a content policy.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontentpolicyconfig.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_wisdom import mixins as wisdom_mixins

a_iGuardrail_content_policy_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty(
    filters_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
        input_strength="inputStrength",
        output_strength="outputStrength",
        type="type"
    )]
)

Attributes

filters_config

List of content filter configurations in a content policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontentpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontentpolicyconfig-filtersconfig

AIGuardrailContextualGroundingPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(*, filters_config=None)

Bases: object

Contextual grounding policy config for a guardrail.

Parameters:: filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContextualGroundingFilterConfigProperty, Dict[str, Any]]], None]) – List of contextual grounding filter configs.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig.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_wisdom import mixins as wisdom_mixins

a_iGuardrail_contextual_grounding_policy_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty(
    filters_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
        threshold=123,
        type="type"
    )]
)

Attributes

filters_config

List of contextual grounding filter configs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailcontextualgroundingpolicyconfig-filtersconfig

AIGuardrailSensitiveInformationPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(*, pii_entities_config=None, regexes_config=None)

Bases: object

Sensitive information policy configuration for a guardrail.

Parameters:

pii_entities_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailPiiEntityConfigProperty, Dict[str, Any]]], None]) – List of entities.
regexes_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailRegexConfigProperty, Dict[str, Any]]], None]) – List of regex.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.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_wisdom import mixins as wisdom_mixins

a_iGuardrail_sensitive_information_policy_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty(
    pii_entities_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
        action="action",
        type="type"
    )],
    regexes_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
        action="action",
        description="description",
        name="name",
        pattern="pattern"
    )]
)

Attributes

pii_entities_config

List of entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-piientitiesconfig

regexes_config

List of regex.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailsensitiveinformationpolicyconfig-regexesconfig

AIGuardrailTopicPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(*, topics_config=None)

Bases: object

Topic policy configuration for a guardrail.

Parameters:: topics_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailTopicConfigProperty, Dict[str, Any]]], None]) – List of topic configs in topic policy.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailtopicpolicyconfig.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_wisdom import mixins as wisdom_mixins

a_iGuardrail_topic_policy_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty(
    topics_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
        definition="definition",
        examples=["examples"],
        name="name",
        type="type"
    )]
)

Attributes

topics_config

List of topic configs in topic policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailtopicpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailtopicpolicyconfig-topicsconfig

AIGuardrailWordPolicyConfigProperty

class CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(*, managed_word_lists_config=None, words_config=None)

Bases: object

Word policy config for a guardrail.

Parameters:

managed_word_lists_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailManagedWordsConfigProperty, Dict[str, Any]]], None]) – A config for the list of managed words.
words_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailWordConfigProperty, Dict[str, Any]]], None]) – List of custom word configurations.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.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_wisdom import mixins as wisdom_mixins

a_iGuardrail_word_policy_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty(
    managed_word_lists_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
        type="type"
    )],
    words_config=[wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
        text="text"
    )]
)

Attributes

managed_word_lists_config

A config for the list of managed words.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-managedwordlistsconfig

words_config

List of custom word configurations.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-aiguardrailwordpolicyconfig.html#cfn-wisdom-aiguardrail-aiguardrailwordpolicyconfig-wordsconfig

GuardrailContentFilterConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(*, input_strength=None, output_strength=None, type=None)

Bases: object

Content filter configuration in content policy.

Parameters:

input_strength (Optional[str]) – The strength of the input for the guardrail content filter.
output_strength (Optional[str]) – The output strength of the guardrail content filter.
type (Optional[str]) – The type of the guardrail content filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.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_wisdom import mixins as wisdom_mixins

guardrail_content_filter_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContentFilterConfigProperty(
    input_strength="inputStrength",
    output_strength="outputStrength",
    type="type"
)

Attributes

input_strength

The strength of the input for the guardrail content filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-inputstrength

output_strength

The output strength of the guardrail content filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-outputstrength

type

The type of the guardrail content filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontentfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontentfilterconfig-type

GuardrailContextualGroundingFilterConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(*, threshold=None, type=None)

Bases: object

A configuration for grounding filter.

Parameters:

threshold (Union[int, float, None]) – The threshold for this filter. Default: - 0
type (Optional[str]) – The type of this filter.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.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_wisdom import mixins as wisdom_mixins

guardrail_contextual_grounding_filter_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailContextualGroundingFilterConfigProperty(
    threshold=123,
    type="type"
)

Attributes

threshold

The threshold for this filter.

Default:

0

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-threshold

type

The type of this filter.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig.html#cfn-wisdom-aiguardrail-guardrailcontextualgroundingfilterconfig-type

GuardrailManagedWordsConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(*, type=None)

Bases: object

A managed words config.

Parameters:: type (Optional[str]) – The type of guardrail managed words.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailmanagedwordsconfig.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_wisdom import mixins as wisdom_mixins

guardrail_managed_words_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailManagedWordsConfigProperty(
    type="type"
)

Attributes

type

The type of guardrail managed words.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailmanagedwordsconfig.html#cfn-wisdom-aiguardrail-guardrailmanagedwordsconfig-type

GuardrailPiiEntityConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(*, action=None, type=None)

Bases: object

PII entity configuration.

Parameters:

action (Optional[str]) – The action of guardrail PII entity configuration.
type (Optional[str]) – The currently supported PII entities.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.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_wisdom import mixins as wisdom_mixins

guardrail_pii_entity_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailPiiEntityConfigProperty(
    action="action",
    type="type"
)

Attributes

action

The action of guardrail PII entity configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-action

type

The currently supported PII entities.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailpiientityconfig.html#cfn-wisdom-aiguardrail-guardrailpiientityconfig-type

GuardrailRegexConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(*, action=None, description=None, name=None, pattern=None)

Bases: object

A regex configuration.

Parameters:

action (Optional[str]) – The action of the guardrail regex configuration.
description (Optional[str]) – The regex description.
name (Optional[str]) – A regex configuration.
pattern (Optional[str]) – The regex pattern.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.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_wisdom import mixins as wisdom_mixins

guardrail_regex_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailRegexConfigProperty(
    action="action",
    description="description",
    name="name",
    pattern="pattern"
)

Attributes

action

The action of the guardrail regex configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-action

description

The regex description.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-description

name

A regex configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-name

pattern

The regex pattern.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailregexconfig.html#cfn-wisdom-aiguardrail-guardrailregexconfig-pattern

GuardrailTopicConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(*, definition=None, examples=None, name=None, type=None)

Bases: object

Topic configuration in topic policy.

Parameters:

definition (Optional[str]) – Definition of topic in topic policy.
examples (Optional[Sequence[str]]) – Text example in topic policy.
name (Optional[str]) – Name of topic in topic policy.
type (Optional[str]) – Type of topic in a policy.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.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_wisdom import mixins as wisdom_mixins

guardrail_topic_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailTopicConfigProperty(
    definition="definition",
    examples=["examples"],
    name="name",
    type="type"
)

Attributes

definition

Definition of topic in topic policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-definition

examples

Text example in topic policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-examples

name

Name of topic in topic policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-name

type

Type of topic in a policy.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailtopicconfig.html#cfn-wisdom-aiguardrail-guardrailtopicconfig-type

GuardrailWordConfigProperty

class CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(*, text=None)

Bases: object

A custom word config.

Parameters:: text (Optional[str]) – The custom word text.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailwordconfig.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_wisdom import mixins as wisdom_mixins

guardrail_word_config_property = wisdom_mixins.CfnAIGuardrailPropsMixin.GuardrailWordConfigProperty(
    text="text"
)

Attributes

text

The custom word text.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wisdom-aiguardrail-guardrailwordconfig.html#cfn-wisdom-aiguardrail-guardrailwordconfig-text