CfnGuardrail

class aws_cdk.aws_bedrock.CfnGuardrail(scope, id, *, blocked_input_messaging, blocked_outputs_messaging, name, content_policy_config=None, description=None, kms_key_arn=None, sensitive_information_policy_config=None, tags=None, topic_policy_config=None, word_policy_config=None)

Bases: CfnResource

Creates a guardrail to block topics and to implement safeguards for your generative AI applications.

You can configure the following policies in a guardrail to avoid undesirable and harmful content, filter out denied topics and words, and remove sensitive information for privacy protection.

Content filters - Adjust filter strengths to block input prompts or model responses containing harmful content.
Denied topics - Define a set of topics that are undesirable in the context of your application. These topics will be blocked if detected in user queries or model responses.
Word filters - Configure filters to block undesirable words, phrases, and profanity. Such words can include offensive terms, competitor names etc.
Sensitive information filters - Block or mask sensitive information such as personally identifiable information (PII) or custom regex in user inputs and model responses.

In addition to the above policies, you can also configure the messages to be returned to the user if a user input or model response is in violation of the policies defined in the guardrail.

For more information, see Guardrails for Amazon Bedrock in the Amazon Bedrock User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html
CloudformationResource:: AWS::Bedrock::Guardrail
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_bedrock as bedrock

cfn_guardrail = bedrock.CfnGuardrail(self, "MyCfnGuardrail",
    blocked_input_messaging="blockedInputMessaging",
    blocked_outputs_messaging="blockedOutputsMessaging",
    name="name",

    # the properties below are optional
    content_policy_config=bedrock.CfnGuardrail.ContentPolicyConfigProperty(
        filters_config=[bedrock.CfnGuardrail.ContentFilterConfigProperty(
            input_strength="inputStrength",
            output_strength="outputStrength",
            type="type"
        )]
    ),
    description="description",
    kms_key_arn="kmsKeyArn",
    sensitive_information_policy_config=bedrock.CfnGuardrail.SensitiveInformationPolicyConfigProperty(
        pii_entities_config=[bedrock.CfnGuardrail.PiiEntityConfigProperty(
            action="action",
            type="type"
        )],
        regexes_config=[bedrock.CfnGuardrail.RegexConfigProperty(
            action="action",
            name="name",
            pattern="pattern",

            # the properties below are optional
            description="description"
        )]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    topic_policy_config=bedrock.CfnGuardrail.TopicPolicyConfigProperty(
        topics_config=[bedrock.CfnGuardrail.TopicConfigProperty(
            definition="definition",
            name="name",
            type="type",

            # the properties below are optional
            examples=["examples"]
        )]
    ),
    word_policy_config=bedrock.CfnGuardrail.WordPolicyConfigProperty(
        managed_word_lists_config=[bedrock.CfnGuardrail.ManagedWordsConfigProperty(
            type="type"
        )],
        words_config=[bedrock.CfnGuardrail.WordConfigProperty(
            text="text"
        )]
    )
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
blocked_input_messaging (str) – The message to return when the guardrail blocks a prompt.
blocked_outputs_messaging (str) – The message to return when the guardrail blocks a model response.
name (str) – The name of the guardrail.
content_policy_config (Union[IResolvable, ContentPolicyConfigProperty, Dict[str, Any], None]) – The content filter policies to configure for the guardrail.
description (Optional[str]) – A description of the guardrail.
kms_key_arn (Optional[str]) – The ARN of the AWS KMS key that you use to encrypt 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.

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::Bedrock::Guardrail'

attr_created_at

The date and time at which the guardrail was created.

CloudformationAttribute:: CreatedAt

attr_failure_recommendations

Appears if the status of the guardrail is FAILED .

A list of recommendations to carry out before retrying the request.

CloudformationAttribute:: FailureRecommendations

attr_guardrail_arn

The ARN of the guardrail.

CloudformationAttribute:: GuardrailArn

attr_guardrail_id

The unique identifier of the guardrail.

CloudformationAttribute:: GuardrailId

attr_status

The status of the guardrail.

CloudformationAttribute:: Status

attr_status_reasons

Appears if the status is FAILED .

A list of reasons for why the guardrail failed to be created, updated, versioned, or deleted.

CloudformationAttribute:: StatusReasons

attr_updated_at

The date and time at which the guardrail was last updated.

CloudformationAttribute:: UpdatedAt

attr_version

The version of the guardrail that was created.

This value will always be DRAFT .

CloudformationAttribute:: Version

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

blocked_outputs_messaging: The message to return when the 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: The content filter policies to configure for the guardrail.

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 guardrail.

kms_key_arn: The ARN of the AWS KMS key that you use to encrypt the guardrail.

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 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: The sensitive information policy to configure for the guardrail.

stack

The stack in which this element is defined.

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

tags: The tags that you want to attach to the guardrail.

topic_policy_config: The topic policies to configure for the guardrail.

word_policy_config: The word policy you configure for the guardrail.

Static Methods

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.

ContentFilterConfigProperty

class CfnGuardrail.ContentFilterConfigProperty(*, input_strength, output_strength, type)

Bases: object

Contains filter strengths for harmful content.

Guardrails support the following content filters to detect and filter harmful user inputs and FM-generated outputs.

Hate – Describes language or a statement that discriminates, criticizes, insults, denounces, or dehumanizes a person or group on the basis of an identity (such as race, ethnicity, gender, religion, sexual orientation, ability, and national origin).
Insults – Describes language or a statement that includes demeaning, humiliating, mocking, insulting, or belittling language. This type of language is also labeled as bullying.
Sexual – Describes language or a statement that indicates sexual interest, activity, or arousal using direct or indirect references to body parts, physical traits, or sex.
Violence – Describes language or a statement that includes glorification of or threats to inflict physical pain, hurt, or injury toward a person, group or thing.

Content filtering depends on the confidence classification of user inputs and FM responses across each of the four harmful categories. All input and output statements are classified into one of four confidence levels (NONE, LOW, MEDIUM, HIGH) for each harmful category. For example, if a statement is classified as Hate with HIGH confidence, the likelihood of the statement representing hateful content is high. A single statement can be classified across multiple categories with varying confidence levels. For example, a single statement can be classified as Hate with HIGH confidence, Insults with LOW confidence, Sexual with NONE confidence, and Violence with MEDIUM confidence.

For more information, see Guardrails content filters .

Parameters:

input_strength (str) – The strength of the content filter to apply to prompts. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
output_strength (str) – The strength of the content filter to apply to model responses. As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.
type (str) – The harmful category that the content filter is applied to.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.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_bedrock as bedrock

content_filter_config_property = bedrock.CfnGuardrail.ContentFilterConfigProperty(
    input_strength="inputStrength",
    output_strength="outputStrength",
    type="type"
)

Attributes

input_strength

The strength of the content filter to apply to prompts.

As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-inputstrength

output_strength

The strength of the content filter to apply to model responses.

As you increase the filter strength, the likelihood of filtering harmful content increases and the probability of seeing harmful content in your application reduces.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-outputstrength

type

The harmful category that the content filter is applied to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentfilterconfig.html#cfn-bedrock-guardrail-contentfilterconfig-type

ContentPolicyConfigProperty

class CfnGuardrail.ContentPolicyConfigProperty(*, filters_config)

Bases: object

Contains details about how to handle harmful content.

Parameters:: filters_config (Union[IResolvable, Sequence[Union[IResolvable, ContentFilterConfigProperty, Dict[str, Any]]]]) – Contains the type of the content filter and how strongly it should apply to prompts and model responses.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-contentpolicyconfig.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_bedrock as bedrock

content_policy_config_property = bedrock.CfnGuardrail.ContentPolicyConfigProperty(
    filters_config=[bedrock.CfnGuardrail.ContentFilterConfigProperty(
        input_strength="inputStrength",
        output_strength="outputStrength",
        type="type"
    )]
)

Attributes

filters_config

Contains the type of the content filter and how strongly it should apply to prompts and model responses.

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

ManagedWordsConfigProperty

class CfnGuardrail.ManagedWordsConfigProperty(*, type)

Bases: object

The managed word list to configure for the guardrail.

Parameters:: type (str) – The managed word type to configure for the guardrail.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.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_bedrock as bedrock

managed_words_config_property = bedrock.CfnGuardrail.ManagedWordsConfigProperty(
    type="type"
)

Attributes

type

The managed word type to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-managedwordsconfig.html#cfn-bedrock-guardrail-managedwordsconfig-type

PiiEntityConfigProperty

class CfnGuardrail.PiiEntityConfigProperty(*, action, type)

Bases: object

The PII entity to configure for the guardrail.

Parameters:

action (str) – Configure guardrail action when the PII entity is detected.
type (str) – Configure 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. guardrails doesn’t apply this entity type to names that are part of organizations or addresses. For example, guardrails 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 - REDIT_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 . Guardrails 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 777 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 a guardrail to recognize and act upon such as serial number, booking ID etc..

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.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_bedrock as bedrock

pii_entity_config_property = bedrock.CfnGuardrail.PiiEntityConfigProperty(
    action="action",
    type="type"
)

Attributes

action

Configure guardrail action when the PII entity is detected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-action

type

Configure 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. guardrails doesn’t apply this entity type to names that are part of organizations or addresses. For example, guardrails 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
REDIT_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 . Guardrails 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 777 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 a guardrail to recognize and act upon such as serial number, booking ID etc..

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-piientityconfig.html#cfn-bedrock-guardrail-piientityconfig-type

RegexConfigProperty

class CfnGuardrail.RegexConfigProperty(*, action, name, pattern, description=None)

Bases: object

The regular expression to configure for the guardrail.

Parameters:

action (str) – The guardrail action to configure when matching regular expression is detected.
name (str) – The name of the regular expression to configure for the guardrail.
pattern (str) – The regular expression pattern to configure for the guardrail.
description (Optional[str]) – The description of the regular expression to configure for the guardrail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.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_bedrock as bedrock

regex_config_property = bedrock.CfnGuardrail.RegexConfigProperty(
    action="action",
    name="name",
    pattern="pattern",

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

Attributes

action

The guardrail action to configure when matching regular expression is detected.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-action

description

The description of the regular expression to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-description

name

The name of the regular expression to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-name

pattern

The regular expression pattern to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-pattern

SensitiveInformationPolicyConfigProperty

class CfnGuardrail.SensitiveInformationPolicyConfigProperty(*, pii_entities_config=None, regexes_config=None)

Bases: object

Contains details about PII entities and regular expressions to configure for the guardrail.

Parameters:

pii_entities_config (Union[IResolvable, Sequence[Union[IResolvable, PiiEntityConfigProperty, Dict[str, Any]]], None]) – A list of PII entities to configure to the guardrail.
regexes_config (Union[IResolvable, Sequence[Union[IResolvable, RegexConfigProperty, Dict[str, Any]]], None]) – A list of regular expressions to configure to the guardrail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.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_bedrock as bedrock

sensitive_information_policy_config_property = bedrock.CfnGuardrail.SensitiveInformationPolicyConfigProperty(
    pii_entities_config=[bedrock.CfnGuardrail.PiiEntityConfigProperty(
        action="action",
        type="type"
    )],
    regexes_config=[bedrock.CfnGuardrail.RegexConfigProperty(
        action="action",
        name="name",
        pattern="pattern",

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

Attributes

pii_entities_config

A list of PII entities to configure to the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-piientitiesconfig

regexes_config

A list of regular expressions to configure to the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-sensitiveinformationpolicyconfig.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig-regexesconfig

TopicConfigProperty

class CfnGuardrail.TopicConfigProperty(*, definition, name, type, examples=None)

Bases: object

Details about topics for the guardrail to identify and deny.

Parameters:

definition (str) – A definition of the topic to deny.
name (str) – The name of the topic to deny.
type (str) – Specifies to deny the topic.
examples (Optional[Sequence[str]]) – A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.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_bedrock as bedrock

topic_config_property = bedrock.CfnGuardrail.TopicConfigProperty(
    definition="definition",
    name="name",
    type="type",

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

Attributes

definition

A definition of the topic to deny.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-definition

examples

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-examples

name

The name of the topic to deny.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-name

type

Specifies to deny the topic.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicconfig.html#cfn-bedrock-guardrail-topicconfig-type

TopicPolicyConfigProperty

class CfnGuardrail.TopicPolicyConfigProperty(*, topics_config)

Bases: object

Contains details about topics that the guardrail should identify and deny.

Parameters:: topics_config (Union[IResolvable, Sequence[Union[IResolvable, TopicConfigProperty, Dict[str, Any]]]]) – A list of policies related to topics that the guardrail should deny.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.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_bedrock as bedrock

topic_policy_config_property = bedrock.CfnGuardrail.TopicPolicyConfigProperty(
    topics_config=[bedrock.CfnGuardrail.TopicConfigProperty(
        definition="definition",
        name="name",
        type="type",

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

Attributes

topics_config

A list of policies related to topics that the guardrail should deny.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-topicpolicyconfig.html#cfn-bedrock-guardrail-topicpolicyconfig-topicsconfig

WordConfigProperty

class CfnGuardrail.WordConfigProperty(*, text)

Bases: object

A word to configure for the guardrail.

Parameters:: text (str) – Text of the word configured for the guardrail to block.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.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_bedrock as bedrock

word_config_property = bedrock.CfnGuardrail.WordConfigProperty(
    text="text"
)

Attributes

text

Text of the word configured for the guardrail to block.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-text

WordPolicyConfigProperty

class CfnGuardrail.WordPolicyConfigProperty(*, managed_word_lists_config=None, words_config=None)

Bases: object

Contains details about the word policy to configured for the guardrail.

Parameters:

managed_word_lists_config (Union[IResolvable, Sequence[Union[IResolvable, ManagedWordsConfigProperty, Dict[str, Any]]], None]) – A list of managed words to configure for the guardrail.
words_config (Union[IResolvable, Sequence[Union[IResolvable, WordConfigProperty, Dict[str, Any]]], None]) – A list of words to configure for the guardrail.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.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_bedrock as bedrock

word_policy_config_property = bedrock.CfnGuardrail.WordPolicyConfigProperty(
    managed_word_lists_config=[bedrock.CfnGuardrail.ManagedWordsConfigProperty(
        type="type"
    )],
    words_config=[bedrock.CfnGuardrail.WordConfigProperty(
        text="text"
    )]
)

Attributes

managed_word_lists_config

A list of managed words to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-managedwordlistsconfig

words_config

A list of words to configure for the guardrail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordpolicyconfig.html#cfn-bedrock-guardrail-wordpolicyconfig-wordsconfig