CfnAIGuardrail

class aws_cdk.aws_wisdom.CfnAIGuardrail(scope, id, *, assistant_id, blocked_input_messaging, blocked_outputs_messaging, content_policy_config=None, contextual_grounding_policy_config=None, description=None, name=None, sensitive_information_policy_config=None, tags=None, topic_policy_config=None, word_policy_config=None)

Bases: CfnResource

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
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 import aws_wisdom as wisdom

cfn_aIGuardrail = wisdom.CfnAIGuardrail(self, "MyCfnAIGuardrail",
    assistant_id="assistantId",
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",

    # the properties below are optional
    content_policy_config=wisdom.CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty(
        filters_config=[wisdom.CfnAIGuardrail.GuardrailContentFilterConfigProperty(
            input_strength="inputStrength",
            output_strength="outputStrength",
            type="type"
        )]
    ),
    contextual_grounding_policy_config=wisdom.CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty(
        filters_config=[wisdom.CfnAIGuardrail.GuardrailContextualGroundingFilterConfigProperty(
            threshold=123,
            type="type"
        )]
    ),
    description="description",
    name="name",
    sensitive_information_policy_config=wisdom.CfnAIGuardrail.AIGuardrailSensitiveInformationPolicyConfigProperty(
        pii_entities_config=[wisdom.CfnAIGuardrail.GuardrailPiiEntityConfigProperty(
            action="action",
            type="type"
        )],
        regexes_config=[wisdom.CfnAIGuardrail.GuardrailRegexConfigProperty(
            action="action",
            name="name",
            pattern="pattern",

            # the properties below are optional
            description="description"
        )]
    ),
    tags={
        "tags_key": "tags"
    },
    topic_policy_config=wisdom.CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty(
        topics_config=[wisdom.CfnAIGuardrail.GuardrailTopicConfigProperty(
            definition="definition",
            name="name",
            type="type",

            # the properties below are optional
            examples=["examples"]
        )]
    ),
    word_policy_config=wisdom.CfnAIGuardrail.AIGuardrailWordPolicyConfigProperty(
        managed_word_lists_config=[wisdom.CfnAIGuardrail.GuardrailManagedWordsConfigProperty(
            type="type"
        )],
        words_config=[wisdom.CfnAIGuardrail.GuardrailWordConfigProperty(
            text="text"
        )]
    )
)

Create a new AWS::Wisdom::AIGuardrail.

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
assistant_id (str) – The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
blocked_input_messaging (str) – The message to return when the AI Guardrail blocks a prompt.
blocked_outputs_messaging (str) – The message to return when the AI Guardrail blocks a model response.
content_policy_config (Union[IResolvable, AIGuardrailContentPolicyConfigProperty, Dict[str, Any], None]) – Contains details about how to handle harmful content.
contextual_grounding_policy_config (Union[IResolvable, AIGuardrailContextualGroundingPolicyConfigProperty, Dict[str, Any], None]) – The policy configuration details for the AI Guardrail’s contextual grounding policy.
description (Optional[str]) – A description of the AI Guardrail.
name (Optional[str]) – The name of the AI Guardrail.
sensitive_information_policy_config (Union[IResolvable, AIGuardrailSensitiveInformationPolicyConfigProperty, Dict[str, Any], None]) – Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags (Optional[Mapping[str, str]]) – The tags used to organize, track, or control access for this resource.
topic_policy_config (Union[IResolvable, AIGuardrailTopicPolicyConfigProperty, Dict[str, Any], None]) – Contains details about topics that the AI Guardrail should identify and deny.
word_policy_config (Union[IResolvable, AIGuardrailWordPolicyConfigProperty, Dict[str, Any], None]) – Contains details about the word policy to configured for the AI Guardrail.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:: target (CfnResource)
Deprecated:: use addDependency
Stability:: deprecated
Return type:: None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str)
value (Any)

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy])
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint])

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:: key (str)
See:
Return type:: Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:: target (CfnResource)
Return type:: None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::Wisdom::AIGuardrail'

ai_guardrail_ref: A reference to a AIGuardrail resource.

assistant_id: The identifier of the Amazon Q in Connect assistant.

attr_ai_guardrail_arn

The Amazon Resource Name (ARN) of the AI Guardrail.

CloudformationAttribute:: AIGuardrailArn

attr_ai_guardrail_id

The identifier of the Amazon Q in Connect AI Guardrail.

CloudformationAttribute:: AIGuardrailId

attr_assistant_arn

The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

CloudformationAttribute:: AssistantArn

blocked_input_messaging: The message to return when the AI Guardrail blocks a prompt.

blocked_outputs_messaging: The message to return when the AI Guardrail blocks a model response.

cdk_tag_manager: Tag Manager which manages the tags for this resource.

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

content_policy_config: Contains details about how to handle harmful content.

contextual_grounding_policy_config: The policy configuration details for the AI Guardrail’s contextual grounding policy.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

description: A description of the AI Guardrail.

env

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the AI Guardrail.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

sensitive_information_policy_config: Contains details about PII entities and regular expressions to configure for the AI Guardrail.

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: The tags used to organize, track, or control access for this resource.

topic_policy_config: Contains details about topics that the AI Guardrail should identify and deny.

word_policy_config: Contains details about the word policy to configured for the AI Guardrail.

Static Methods

classmethod arn_for_ai_guardrail(resource)

Parameters:: resource (IAIGuardrailRef)
Return type:: str

classmethod is_cfn_ai_guardrail(x)

Checks whether the given object is a CfnAIGuardrail.

Parameters:: x (Any)
Return type:: bool

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:: x (Any)
Return type:: bool
Returns:: The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:: x (Any)
Return type:: bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

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

AIGuardrailContentPolicyConfigProperty

class CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty(*, filters_config)

Bases: object

Content policy config for a guardrail.

Parameters:: filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContentFilterConfigProperty, Dict[str, Any]]]]) – 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 import aws_wisdom as wisdom

a_iGuardrail_content_policy_config_property = wisdom.CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty(
    filters_config=[wisdom.CfnAIGuardrail.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 CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty(*, filters_config)

Bases: object

Contextual grounding policy config for a guardrail.

Parameters:: filters_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailContextualGroundingFilterConfigProperty, Dict[str, Any]]]]) – 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 import aws_wisdom as wisdom

a_iGuardrail_contextual_grounding_policy_config_property = wisdom.CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty(
    filters_config=[wisdom.CfnAIGuardrail.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 CfnAIGuardrail.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 import aws_wisdom as wisdom

a_iGuardrail_sensitive_information_policy_config_property = wisdom.CfnAIGuardrail.AIGuardrailSensitiveInformationPolicyConfigProperty(
    pii_entities_config=[wisdom.CfnAIGuardrail.GuardrailPiiEntityConfigProperty(
        action="action",
        type="type"
    )],
    regexes_config=[wisdom.CfnAIGuardrail.GuardrailRegexConfigProperty(
        action="action",
        name="name",
        pattern="pattern",

        # the properties below are optional
        description="description"
    )]
)

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 CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty(*, topics_config)

Bases: object

Topic policy configuration for a guardrail.

Parameters:: topics_config (Union[IResolvable, Sequence[Union[IResolvable, GuardrailTopicConfigProperty, Dict[str, Any]]]]) – 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 import aws_wisdom as wisdom

a_iGuardrail_topic_policy_config_property = wisdom.CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty(
    topics_config=[wisdom.CfnAIGuardrail.GuardrailTopicConfigProperty(
        definition="definition",
        name="name",
        type="type",

        # the properties below are optional
        examples=["examples"]
    )]
)

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 CfnAIGuardrail.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 import aws_wisdom as wisdom

a_iGuardrail_word_policy_config_property = wisdom.CfnAIGuardrail.AIGuardrailWordPolicyConfigProperty(
    managed_word_lists_config=[wisdom.CfnAIGuardrail.GuardrailManagedWordsConfigProperty(
        type="type"
    )],
    words_config=[wisdom.CfnAIGuardrail.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 CfnAIGuardrail.GuardrailContentFilterConfigProperty(*, input_strength, output_strength, type)

Bases: object

Content filter configuration in content policy.

Parameters:

input_strength (str) – The strength of the input for the guardrail content filter.
output_strength (str) – The output strength of the guardrail content filter.
type (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 import aws_wisdom as wisdom

guardrail_content_filter_config_property = wisdom.CfnAIGuardrail.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 CfnAIGuardrail.GuardrailContextualGroundingFilterConfigProperty(*, threshold, type)

Bases: object

A configuration for grounding filter.

Parameters:

threshold (Union[int, float]) – The threshold for this filter. Default: - 0
type (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 import aws_wisdom as wisdom

guardrail_contextual_grounding_filter_config_property = wisdom.CfnAIGuardrail.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 CfnAIGuardrail.GuardrailManagedWordsConfigProperty(*, type)

Bases: object

A managed words config.

Parameters:: type (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 import aws_wisdom as wisdom

guardrail_managed_words_config_property = wisdom.CfnAIGuardrail.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 CfnAIGuardrail.GuardrailPiiEntityConfigProperty(*, action, type)

Bases: object

PII entity configuration.

Parameters:

action (str) – The action of guardrail PII entity configuration.
type (str) – Configure AI Guardrail type when the PII entity is detected. The following PIIs are used to block or mask sensitive information: - General - ADDRESS A physical address, such as “100 Main Street, Anytown, USA” or “Suite #12, Building 123”. An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood. - AGE An individual’s age, including the quantity and unit of time. For example, in the phrase “I am 40 years old,” Guarrails recognizes “40 years” as an age. - NAME An individual’s name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn’t apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the “John Doe Organization” as an organization, and it recognizes “Jane Doe Street” as an address. - EMAIL An email address, such as marymajor@email.com . - PHONE A phone number. This entity type also includes fax and pager numbers. - USERNAME A user name that identifies an account, such as a login name, screen name, nick name, or handle. - PASSWORD An alphanumeric string that is used as a password, such as “* very20special#pass* “. - DRIVER_ID The number assigned to a driver’s license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver’s license number consists of alphanumeric characters. - LICENSE_PLATE A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country. - VEHICLE_IDENTIFICATION_NUMBER A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs. - Finance - CREDIT_DEBIT_CARD_CVV A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code. - CREDIT_DEBIT_CARD_EXPIRY The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . AI Guardrail recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 . - CREDIT_DEBIT_CARD_NUMBER The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present. - PIN A four-digit personal identification number (PIN) with which you can access your bank account. - INTERNATIONAL_BANK_ACCOUNT_NUMBER An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure . - SWIFT_CODE A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers. SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in ‘XXX’) refer to the head or primary office. - IT - IP_ADDRESS An IPv4 address, such as 198.51.100.0 . - MAC_ADDRESS A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC). - URL A web address, such as www.example.com . - AWS_ACCESS_KEY A unique identifier that’s associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically. - AWS_SECRET_KEY A unique identifier that’s associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically. - USA specific - US_BANK_ACCOUNT_NUMBER A US bank account number, which is typically 10 to 12 digits long. - US_BANK_ROUTING_NUMBER A US bank account routing number. These are typically nine digits long, - US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a “9” and contain a “7” or “8” as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits. - US_PASSPORT_NUMBER A US passport number. Passport numbers range from six to nine alphanumeric characters. - US_SOCIAL_SECURITY_NUMBER A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents. - Canada specific - CA_HEALTH_NUMBER A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits. - CA_SOCIAL_INSURANCE_NUMBER A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits. The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm . - UK Specific - UK_NATIONAL_HEALTH_SERVICE_NUMBER A UK National Health Service Number is a 10-17 digit number, such as 485 555 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum. - UK_NATIONAL_INSURANCE_NUMBER A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system. The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits. - UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business. - Custom - Regex filter - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

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 import aws_wisdom as wisdom

guardrail_pii_entity_config_property = wisdom.CfnAIGuardrail.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

Configure AI Guardrail type when the PII entity is detected.

The following PIIs are used to block or mask sensitive information:

General
ADDRESS

A physical address, such as “100 Main Street, Anytown, USA” or “Suite #12, Building 123”. An address can include information such as the street, building, location, city, state, country, county, zip code, precinct, and neighborhood.

AGE

An individual’s age, including the quantity and unit of time. For example, in the phrase “I am 40 years old,” Guarrails recognizes “40 years” as an age.

NAME

An individual’s name. This entity type does not include titles, such as Dr., Mr., Mrs., or Miss. AI Guardrail doesn’t apply this entity type to names that are part of organizations or addresses. For example, AI Guardrail recognizes the “John Doe Organization” as an organization, and it recognizes “Jane Doe Street” as an address.

EMAIL

An email address, such as marymajor@email.com .

PHONE

A phone number. This entity type also includes fax and pager numbers.

USERNAME

A user name that identifies an account, such as a login name, screen name, nick name, or handle.

PASSWORD

An alphanumeric string that is used as a password, such as “* very20special#pass* “.

DRIVER_ID

The number assigned to a driver’s license, which is an official document permitting an individual to operate one or more motorized vehicles on a public road. A driver’s license number consists of alphanumeric characters.

LICENSE_PLATE

A license plate for a vehicle is issued by the state or country where the vehicle is registered. The format for passenger vehicles is typically five to eight digits, consisting of upper-case letters and numbers. The format varies depending on the location of the issuing state or country.

VEHICLE_IDENTIFICATION_NUMBER

A Vehicle Identification Number (VIN) uniquely identifies a vehicle. VIN content and format are defined in the ISO 3779 specification. Each country has specific codes and formats for VINs.

Finance
CREDIT_DEBIT_CARD_CVV

A three-digit card verification code (CVV) that is present on VISA, MasterCard, and Discover credit and debit cards. For American Express credit or debit cards, the CVV is a four-digit numeric code.

CREDIT_DEBIT_CARD_EXPIRY

The expiration date for a credit or debit card. This number is usually four digits long and is often formatted as month/year or MM/YY . AI Guardrail recognizes expiration dates such as 01/21 , 01/2021 , and Jan 2021 .

CREDIT_DEBIT_CARD_NUMBER

The number for a credit or debit card. These numbers can vary from 13 to 16 digits in length. However, Amazon Comprehend also recognizes credit or debit card numbers when only the last four digits are present.

PIN

A four-digit personal identification number (PIN) with which you can access your bank account.

INTERNATIONAL_BANK_ACCOUNT_NUMBER

An International Bank Account Number has specific formats in each country. For more information, see www.iban.com/structure .

SWIFT_CODE

A SWIFT code is a standard format of Bank Identifier Code (BIC) used to specify a particular bank or branch. Banks use these codes for money transfers such as international wire transfers.

SWIFT codes consist of eight or 11 characters. The 11-digit codes refer to specific branches, while eight-digit codes (or 11-digit codes ending in ‘XXX’) refer to the head or primary office.

IT
IP_ADDRESS

An IPv4 address, such as 198.51.100.0 .

MAC_ADDRESS

A media access control (MAC) address is a unique identifier assigned to a network interface controller (NIC).

URL

A web address, such as www.example.com .

AWS_ACCESS_KEY

A unique identifier that’s associated with a secret access key; you use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

AWS_SECRET_KEY

A unique identifier that’s associated with an access key. You use the access key ID and secret access key to sign programmatic AWS requests cryptographically.

USA specific
US_BANK_ACCOUNT_NUMBER

A US bank account number, which is typically 10 to 12 digits long.

US_BANK_ROUTING_NUMBER

A US bank account routing number. These are typically nine digits long,

US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER

A US Individual Taxpayer Identification Number (ITIN) is a nine-digit number that starts with a “9” and contain a “7” or “8” as the fourth digit. An ITIN can be formatted with a space or a dash after the third and forth digits.

US_PASSPORT_NUMBER

A US passport number. Passport numbers range from six to nine alphanumeric characters.

US_SOCIAL_SECURITY_NUMBER

A US Social Security Number (SSN) is a nine-digit number that is issued to US citizens, permanent residents, and temporary working residents.

Canada specific
CA_HEALTH_NUMBER

A Canadian Health Service Number is a 10-digit unique identifier, required for individuals to access healthcare benefits.

CA_SOCIAL_INSURANCE_NUMBER

A Canadian Social Insurance Number (SIN) is a nine-digit unique identifier, required for individuals to access government programs and benefits.

The SIN is formatted as three groups of three digits, such as 123-456-789 . A SIN can be validated through a simple check-digit process called the Luhn algorithm .

UK Specific
UK_NATIONAL_HEALTH_SERVICE_NUMBER

A UK National Health Service Number is a 10-17 digit number, such as 485 555 3456 . The current system formats the 10-digit number with spaces after the third and sixth digits. The final digit is an error-detecting checksum.

UK_NATIONAL_INSURANCE_NUMBER

A UK National Insurance Number (NINO) provides individuals with access to National Insurance (social security) benefits. It is also used for some purposes in the UK tax system.

The number is nine digits long and starts with two letters, followed by six numbers and one letter. A NINO can be formatted with a space or a dash after the two letters and after the second, forth, and sixth digits.

UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER

A UK Unique Taxpayer Reference (UTR) is a 10-digit number that identifies a taxpayer or a business.

Custom
Regex filter - You can use a regular expressions to define patterns for an AI Guardrail to recognize and act upon such as serial number, booking ID etc..

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

GuardrailRegexConfigProperty

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

Bases: object

A regex configuration.

Parameters:

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

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 import aws_wisdom as wisdom

guardrail_regex_config_property = wisdom.CfnAIGuardrail.GuardrailRegexConfigProperty(
    action="action",
    name="name",
    pattern="pattern",

    # the properties below are optional
    description="description"
)

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 CfnAIGuardrail.GuardrailTopicConfigProperty(*, definition, name, type, examples=None)

Bases: object

Topic configuration in topic policy.

Parameters:

definition (str) – Definition of topic in topic policy.
name (str) – Name of topic in topic policy.
type (str) – Type of topic in a policy.
examples (Optional[Sequence[str]]) – Text example in topic 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 import aws_wisdom as wisdom

guardrail_topic_config_property = wisdom.CfnAIGuardrail.GuardrailTopicConfigProperty(
    definition="definition",
    name="name",
    type="type",

    # the properties below are optional
    examples=["examples"]
)

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 CfnAIGuardrail.GuardrailWordConfigProperty(*, text)

Bases: object

A custom word config.

Parameters:: text (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 import aws_wisdom as wisdom

guardrail_word_config_property = wisdom.CfnAIGuardrail.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