1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. bedrock
  5. Guardrail

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

aws-native.bedrock.Guardrail

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi

    Definition of AWS::Bedrock::Guardrail Resource Type

    Create Guardrail Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Guardrail(name: string, args: GuardrailArgs, opts?: CustomResourceOptions);
    @overload
    def Guardrail(resource_name: str,
                  args: GuardrailArgs,
                  opts: Optional[ResourceOptions] = None)
    
    @overload
    def Guardrail(resource_name: str,
                  opts: Optional[ResourceOptions] = None,
                  blocked_input_messaging: Optional[str] = None,
                  blocked_outputs_messaging: Optional[str] = None,
                  content_policy_config: Optional[GuardrailContentPolicyConfigArgs] = None,
                  contextual_grounding_policy_config: Optional[GuardrailContextualGroundingPolicyConfigArgs] = None,
                  description: Optional[str] = None,
                  kms_key_arn: Optional[str] = None,
                  name: Optional[str] = None,
                  sensitive_information_policy_config: Optional[GuardrailSensitiveInformationPolicyConfigArgs] = None,
                  tags: Optional[Sequence[_root_inputs.TagArgs]] = None,
                  topic_policy_config: Optional[GuardrailTopicPolicyConfigArgs] = None,
                  word_policy_config: Optional[GuardrailWordPolicyConfigArgs] = None)
    func NewGuardrail(ctx *Context, name string, args GuardrailArgs, opts ...ResourceOption) (*Guardrail, error)
    public Guardrail(string name, GuardrailArgs args, CustomResourceOptions? opts = null)
    public Guardrail(String name, GuardrailArgs args)
    public Guardrail(String name, GuardrailArgs args, CustomResourceOptions options)
    
    type: aws-native:bedrock:Guardrail
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args GuardrailArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Guardrail Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Guardrail resource accepts the following input properties:

    BlockedInputMessaging string
    Messaging for when violations are detected in text
    BlockedOutputsMessaging string
    Messaging for when violations are detected in text
    ContentPolicyConfig Pulumi.AwsNative.Bedrock.Inputs.GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    ContextualGroundingPolicyConfig Pulumi.AwsNative.Bedrock.Inputs.GuardrailContextualGroundingPolicyConfig
    Description string
    Description of the guardrail or its version
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest
    Name string
    Name of the guardrail
    SensitiveInformationPolicyConfig Pulumi.AwsNative.Bedrock.Inputs.GuardrailSensitiveInformationPolicyConfig
    The sensitive information policy to configure for the guardrail.
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    List of Tags
    TopicPolicyConfig Pulumi.AwsNative.Bedrock.Inputs.GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    WordPolicyConfig Pulumi.AwsNative.Bedrock.Inputs.GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    BlockedInputMessaging string
    Messaging for when violations are detected in text
    BlockedOutputsMessaging string
    Messaging for when violations are detected in text
    ContentPolicyConfig GuardrailContentPolicyConfigArgs
    The content filter policies to configure for the guardrail.
    ContextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfigArgs
    Description string
    Description of the guardrail or its version
    KmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest
    Name string
    Name of the guardrail
    SensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfigArgs
    The sensitive information policy to configure for the guardrail.
    Tags TagArgs
    List of Tags
    TopicPolicyConfig GuardrailTopicPolicyConfigArgs
    The topic policies to configure for the guardrail.
    WordPolicyConfig GuardrailWordPolicyConfigArgs
    The word policy you configure for the guardrail.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    description String
    Description of the guardrail or its version
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest
    name String
    Name of the guardrail
    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    The sensitive information policy to configure for the guardrail.
    tags List<Tag>
    List of Tags
    topicPolicyConfig GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    wordPolicyConfig GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    blockedInputMessaging string
    Messaging for when violations are detected in text
    blockedOutputsMessaging string
    Messaging for when violations are detected in text
    contentPolicyConfig GuardrailContentPolicyConfig
    The content filter policies to configure for the guardrail.
    contextualGroundingPolicyConfig GuardrailContextualGroundingPolicyConfig
    description string
    Description of the guardrail or its version
    kmsKeyArn string
    The KMS key with which the guardrail was encrypted at rest
    name string
    Name of the guardrail
    sensitiveInformationPolicyConfig GuardrailSensitiveInformationPolicyConfig
    The sensitive information policy to configure for the guardrail.
    tags Tag[]
    List of Tags
    topicPolicyConfig GuardrailTopicPolicyConfig
    The topic policies to configure for the guardrail.
    wordPolicyConfig GuardrailWordPolicyConfig
    The word policy you configure for the guardrail.
    blocked_input_messaging str
    Messaging for when violations are detected in text
    blocked_outputs_messaging str
    Messaging for when violations are detected in text
    content_policy_config GuardrailContentPolicyConfigArgs
    The content filter policies to configure for the guardrail.
    contextual_grounding_policy_config GuardrailContextualGroundingPolicyConfigArgs
    description str
    Description of the guardrail or its version
    kms_key_arn str
    The KMS key with which the guardrail was encrypted at rest
    name str
    Name of the guardrail
    sensitive_information_policy_config GuardrailSensitiveInformationPolicyConfigArgs
    The sensitive information policy to configure for the guardrail.
    tags Sequence[TagArgs]
    List of Tags
    topic_policy_config GuardrailTopicPolicyConfigArgs
    The topic policies to configure for the guardrail.
    word_policy_config GuardrailWordPolicyConfigArgs
    The word policy you configure for the guardrail.
    blockedInputMessaging String
    Messaging for when violations are detected in text
    blockedOutputsMessaging String
    Messaging for when violations are detected in text
    contentPolicyConfig Property Map
    The content filter policies to configure for the guardrail.
    contextualGroundingPolicyConfig Property Map
    description String
    Description of the guardrail or its version
    kmsKeyArn String
    The KMS key with which the guardrail was encrypted at rest
    name String
    Name of the guardrail
    sensitiveInformationPolicyConfig Property Map
    The sensitive information policy to configure for the guardrail.
    tags List<Property Map>
    List of Tags
    topicPolicyConfig Property Map
    The topic policies to configure for the guardrail.
    wordPolicyConfig Property Map
    The word policy you configure for the guardrail.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Guardrail resource produces the following output properties:

    CreatedAt string
    Time Stamp
    FailureRecommendations List<string>
    List of failure recommendations
    GuardrailArn string
    Arn representation for the guardrail
    GuardrailId string
    Unique id for the guardrail
    Id string
    The provider-assigned unique ID for this managed resource.
    Status Pulumi.AwsNative.Bedrock.GuardrailStatus
    The status of the guardrail.
    StatusReasons List<string>
    List of status reasons
    UpdatedAt string
    Time Stamp
    Version string
    Guardrail version
    CreatedAt string
    Time Stamp
    FailureRecommendations []string
    List of failure recommendations
    GuardrailArn string
    Arn representation for the guardrail
    GuardrailId string
    Unique id for the guardrail
    Id string
    The provider-assigned unique ID for this managed resource.
    Status GuardrailStatus
    The status of the guardrail.
    StatusReasons []string
    List of status reasons
    UpdatedAt string
    Time Stamp
    Version string
    Guardrail version
    createdAt String
    Time Stamp
    failureRecommendations List<String>
    List of failure recommendations
    guardrailArn String
    Arn representation for the guardrail
    guardrailId String
    Unique id for the guardrail
    id String
    The provider-assigned unique ID for this managed resource.
    status GuardrailStatus
    The status of the guardrail.
    statusReasons List<String>
    List of status reasons
    updatedAt String
    Time Stamp
    version String
    Guardrail version
    createdAt string
    Time Stamp
    failureRecommendations string[]
    List of failure recommendations
    guardrailArn string
    Arn representation for the guardrail
    guardrailId string
    Unique id for the guardrail
    id string
    The provider-assigned unique ID for this managed resource.
    status GuardrailStatus
    The status of the guardrail.
    statusReasons string[]
    List of status reasons
    updatedAt string
    Time Stamp
    version string
    Guardrail version
    created_at str
    Time Stamp
    failure_recommendations Sequence[str]
    List of failure recommendations
    guardrail_arn str
    Arn representation for the guardrail
    guardrail_id str
    Unique id for the guardrail
    id str
    The provider-assigned unique ID for this managed resource.
    status GuardrailStatus
    The status of the guardrail.
    status_reasons Sequence[str]
    List of status reasons
    updated_at str
    Time Stamp
    version str
    Guardrail version
    createdAt String
    Time Stamp
    failureRecommendations List<String>
    List of failure recommendations
    guardrailArn String
    Arn representation for the guardrail
    guardrailId String
    Unique id for the guardrail
    id String
    The provider-assigned unique ID for this managed resource.
    status "CREATING" | "UPDATING" | "VERSIONING" | "READY" | "FAILED" | "DELETING"
    The status of the guardrail.
    statusReasons List<String>
    List of status reasons
    updatedAt String
    Time Stamp
    version String
    Guardrail version

    Supporting Types

    GuardrailContentFilterConfig, GuardrailContentFilterConfigArgs

    InputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
    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.
    OutputStrength Pulumi.AwsNative.Bedrock.GuardrailFilterStrength
    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 Pulumi.AwsNative.Bedrock.GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    InputStrength GuardrailFilterStrength
    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.
    OutputStrength GuardrailFilterStrength
    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 GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength GuardrailFilterStrength
    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.
    outputStrength GuardrailFilterStrength
    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 GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength GuardrailFilterStrength
    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.
    outputStrength GuardrailFilterStrength
    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 GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    input_strength GuardrailFilterStrength
    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 GuardrailFilterStrength
    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 GuardrailContentFilterType
    The harmful category that the content filter is applied to.
    inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    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.
    outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH"
    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 "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK"
    The harmful category that the content filter is applied to.

    GuardrailContentFilterType, GuardrailContentFilterTypeArgs

    Sexual
    SEXUAL
    Violence
    VIOLENCE
    Hate
    HATE
    Insults
    INSULTS
    Misconduct
    MISCONDUCT
    PromptAttack
    PROMPT_ATTACK
    GuardrailContentFilterTypeSexual
    SEXUAL
    GuardrailContentFilterTypeViolence
    VIOLENCE
    GuardrailContentFilterTypeHate
    HATE
    GuardrailContentFilterTypeInsults
    INSULTS
    GuardrailContentFilterTypeMisconduct
    MISCONDUCT
    GuardrailContentFilterTypePromptAttack
    PROMPT_ATTACK
    Sexual
    SEXUAL
    Violence
    VIOLENCE
    Hate
    HATE
    Insults
    INSULTS
    Misconduct
    MISCONDUCT
    PromptAttack
    PROMPT_ATTACK
    Sexual
    SEXUAL
    Violence
    VIOLENCE
    Hate
    HATE
    Insults
    INSULTS
    Misconduct
    MISCONDUCT
    PromptAttack
    PROMPT_ATTACK
    SEXUAL
    SEXUAL
    VIOLENCE
    VIOLENCE
    HATE
    HATE
    INSULTS
    INSULTS
    MISCONDUCT
    MISCONDUCT
    PROMPT_ATTACK
    PROMPT_ATTACK
    "SEXUAL"
    SEXUAL
    "VIOLENCE"
    VIOLENCE
    "HATE"
    HATE
    "INSULTS"
    INSULTS
    "MISCONDUCT"
    MISCONDUCT
    "PROMPT_ATTACK"
    PROMPT_ATTACK

    GuardrailContentPolicyConfig, GuardrailContentPolicyConfigArgs

    FiltersConfig []GuardrailContentFilterConfig
    List of content filter configs in content policy.
    filtersConfig List<GuardrailContentFilterConfig>
    List of content filter configs in content policy.
    filtersConfig GuardrailContentFilterConfig[]
    List of content filter configs in content policy.
    filters_config Sequence[GuardrailContentFilterConfig]
    List of content filter configs in content policy.
    filtersConfig List<Property Map>
    List of content filter configs in content policy.

    GuardrailContextualGroundingFilterConfig, GuardrailContextualGroundingFilterConfigArgs

    Threshold double
    The threshold for this filter.
    Type Pulumi.AwsNative.Bedrock.GuardrailContextualGroundingFilterType
    The filter details for the guardrails contextual grounding filter.
    Threshold float64
    The threshold for this filter.
    Type GuardrailContextualGroundingFilterType
    The filter details for the guardrails contextual grounding filter.
    threshold Double
    The threshold for this filter.
    type GuardrailContextualGroundingFilterType
    The filter details for the guardrails contextual grounding filter.
    threshold number
    The threshold for this filter.
    type GuardrailContextualGroundingFilterType
    The filter details for the guardrails contextual grounding filter.
    threshold float
    The threshold for this filter.
    type GuardrailContextualGroundingFilterType
    The filter details for the guardrails contextual grounding filter.
    threshold Number
    The threshold for this filter.
    type "GROUNDING" | "RELEVANCE"
    The filter details for the guardrails contextual grounding filter.

    GuardrailContextualGroundingFilterType, GuardrailContextualGroundingFilterTypeArgs

    Grounding
    GROUNDING
    Relevance
    RELEVANCE
    GuardrailContextualGroundingFilterTypeGrounding
    GROUNDING
    GuardrailContextualGroundingFilterTypeRelevance
    RELEVANCE
    Grounding
    GROUNDING
    Relevance
    RELEVANCE
    Grounding
    GROUNDING
    Relevance
    RELEVANCE
    GROUNDING
    GROUNDING
    RELEVANCE
    RELEVANCE
    "GROUNDING"
    GROUNDING
    "RELEVANCE"
    RELEVANCE

    GuardrailContextualGroundingPolicyConfig, GuardrailContextualGroundingPolicyConfigArgs

    FiltersConfig []GuardrailContextualGroundingFilterConfig
    List of contextual grounding filter configs.
    filtersConfig List<GuardrailContextualGroundingFilterConfig>
    List of contextual grounding filter configs.
    filtersConfig GuardrailContextualGroundingFilterConfig[]
    List of contextual grounding filter configs.
    filters_config Sequence[GuardrailContextualGroundingFilterConfig]
    List of contextual grounding filter configs.
    filtersConfig List<Property Map>
    List of contextual grounding filter configs.

    GuardrailFilterStrength, GuardrailFilterStrengthArgs

    None
    NONE
    Low
    LOW
    Medium
    MEDIUM
    High
    HIGH
    GuardrailFilterStrengthNone
    NONE
    GuardrailFilterStrengthLow
    LOW
    GuardrailFilterStrengthMedium
    MEDIUM
    GuardrailFilterStrengthHigh
    HIGH
    None
    NONE
    Low
    LOW
    Medium
    MEDIUM
    High
    HIGH
    None
    NONE
    Low
    LOW
    Medium
    MEDIUM
    High
    HIGH
    NONE
    NONE
    LOW
    LOW
    MEDIUM
    MEDIUM
    HIGH
    HIGH
    "NONE"
    NONE
    "LOW"
    LOW
    "MEDIUM"
    MEDIUM
    "HIGH"
    HIGH

    GuardrailManagedWordsConfig, GuardrailManagedWordsConfigArgs

    Type Pulumi.AwsNative.Bedrock.GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    Type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type GuardrailManagedWordsType
    The managed word type to configure for the guardrail.
    type "PROFANITY"
    The managed word type to configure for the guardrail.

    GuardrailManagedWordsType, GuardrailManagedWordsTypeArgs

    Profanity
    PROFANITY
    GuardrailManagedWordsTypeProfanity
    PROFANITY
    Profanity
    PROFANITY
    Profanity
    PROFANITY
    PROFANITY
    PROFANITY
    "PROFANITY"
    PROFANITY

    GuardrailPiiEntityConfig, GuardrailPiiEntityConfigArgs

    Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    Type Pulumi.AwsNative.Bedrock.GuardrailPiiEntityType

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

    Action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    Type GuardrailPiiEntityType

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

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

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

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

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

    action GuardrailSensitiveInformationAction
    Configure guardrail action when the PII entity is detected.
    type GuardrailPiiEntityType

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

    action "BLOCK" | "ANONYMIZE"
    Configure guardrail action when the PII entity is detected.
    type "ADDRESS" | "AGE" | "AWS_ACCESS_KEY" | "AWS_SECRET_KEY" | "CA_HEALTH_NUMBER" | "CA_SOCIAL_INSURANCE_NUMBER" | "CREDIT_DEBIT_CARD_CVV" | "CREDIT_DEBIT_CARD_EXPIRY" | "CREDIT_DEBIT_CARD_NUMBER" | "DRIVER_ID" | "EMAIL" | "INTERNATIONAL_BANK_ACCOUNT_NUMBER" | "IP_ADDRESS" | "LICENSE_PLATE" | "MAC_ADDRESS" | "NAME" | "PASSWORD" | "PHONE" | "PIN" | "SWIFT_CODE" | "UK_NATIONAL_HEALTH_SERVICE_NUMBER" | "UK_NATIONAL_INSURANCE_NUMBER" | "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER" | "URL" | "USERNAME" | "US_BANK_ACCOUNT_NUMBER" | "US_BANK_ROUTING_NUMBER" | "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER" | "US_PASSPORT_NUMBER" | "US_SOCIAL_SECURITY_NUMBER" | "VEHICLE_IDENTIFICATION_NUMBER"

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

    GuardrailPiiEntityType, GuardrailPiiEntityTypeArgs

    Address
    ADDRESS
    Age
    AGE
    AwsAccessKey
    AWS_ACCESS_KEY
    AwsSecretKey
    AWS_SECRET_KEY
    CaHealthNumber
    CA_HEALTH_NUMBER
    CaSocialInsuranceNumber
    CA_SOCIAL_INSURANCE_NUMBER
    CreditDebitCardCvv
    CREDIT_DEBIT_CARD_CVV
    CreditDebitCardExpiry
    CREDIT_DEBIT_CARD_EXPIRY
    CreditDebitCardNumber
    CREDIT_DEBIT_CARD_NUMBER
    DriverId
    DRIVER_ID
    Email
    EMAIL
    InternationalBankAccountNumber
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    IpAddress
    IP_ADDRESS
    LicensePlate
    LICENSE_PLATE
    MacAddress
    MAC_ADDRESS
    Name
    NAME
    Password
    PASSWORD
    Phone
    PHONE
    Pin
    PIN
    SwiftCode
    SWIFT_CODE
    UkNationalHealthServiceNumber
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    UkNationalInsuranceNumber
    UK_NATIONAL_INSURANCE_NUMBER
    UkUniqueTaxpayerReferenceNumber
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    Url
    URL
    Username
    USERNAME
    UsBankAccountNumber
    US_BANK_ACCOUNT_NUMBER
    UsBankRoutingNumber
    US_BANK_ROUTING_NUMBER
    UsIndividualTaxIdentificationNumber
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    UsPassportNumber
    US_PASSPORT_NUMBER
    UsSocialSecurityNumber
    US_SOCIAL_SECURITY_NUMBER
    VehicleIdentificationNumber
    VEHICLE_IDENTIFICATION_NUMBER
    GuardrailPiiEntityTypeAddress
    ADDRESS
    GuardrailPiiEntityTypeAge
    AGE
    GuardrailPiiEntityTypeAwsAccessKey
    AWS_ACCESS_KEY
    GuardrailPiiEntityTypeAwsSecretKey
    AWS_SECRET_KEY
    GuardrailPiiEntityTypeCaHealthNumber
    CA_HEALTH_NUMBER
    GuardrailPiiEntityTypeCaSocialInsuranceNumber
    CA_SOCIAL_INSURANCE_NUMBER
    GuardrailPiiEntityTypeCreditDebitCardCvv
    CREDIT_DEBIT_CARD_CVV
    GuardrailPiiEntityTypeCreditDebitCardExpiry
    CREDIT_DEBIT_CARD_EXPIRY
    GuardrailPiiEntityTypeCreditDebitCardNumber
    CREDIT_DEBIT_CARD_NUMBER
    GuardrailPiiEntityTypeDriverId
    DRIVER_ID
    GuardrailPiiEntityTypeEmail
    EMAIL
    GuardrailPiiEntityTypeInternationalBankAccountNumber
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    GuardrailPiiEntityTypeIpAddress
    IP_ADDRESS
    GuardrailPiiEntityTypeLicensePlate
    LICENSE_PLATE
    GuardrailPiiEntityTypeMacAddress
    MAC_ADDRESS
    GuardrailPiiEntityTypeName
    NAME
    GuardrailPiiEntityTypePassword
    PASSWORD
    GuardrailPiiEntityTypePhone
    PHONE
    GuardrailPiiEntityTypePin
    PIN
    GuardrailPiiEntityTypeSwiftCode
    SWIFT_CODE
    GuardrailPiiEntityTypeUkNationalHealthServiceNumber
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    GuardrailPiiEntityTypeUkNationalInsuranceNumber
    UK_NATIONAL_INSURANCE_NUMBER
    GuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    GuardrailPiiEntityTypeUrl
    URL
    GuardrailPiiEntityTypeUsername
    USERNAME
    GuardrailPiiEntityTypeUsBankAccountNumber
    US_BANK_ACCOUNT_NUMBER
    GuardrailPiiEntityTypeUsBankRoutingNumber
    US_BANK_ROUTING_NUMBER
    GuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    GuardrailPiiEntityTypeUsPassportNumber
    US_PASSPORT_NUMBER
    GuardrailPiiEntityTypeUsSocialSecurityNumber
    US_SOCIAL_SECURITY_NUMBER
    GuardrailPiiEntityTypeVehicleIdentificationNumber
    VEHICLE_IDENTIFICATION_NUMBER
    Address
    ADDRESS
    Age
    AGE
    AwsAccessKey
    AWS_ACCESS_KEY
    AwsSecretKey
    AWS_SECRET_KEY
    CaHealthNumber
    CA_HEALTH_NUMBER
    CaSocialInsuranceNumber
    CA_SOCIAL_INSURANCE_NUMBER
    CreditDebitCardCvv
    CREDIT_DEBIT_CARD_CVV
    CreditDebitCardExpiry
    CREDIT_DEBIT_CARD_EXPIRY
    CreditDebitCardNumber
    CREDIT_DEBIT_CARD_NUMBER
    DriverId
    DRIVER_ID
    Email
    EMAIL
    InternationalBankAccountNumber
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    IpAddress
    IP_ADDRESS
    LicensePlate
    LICENSE_PLATE
    MacAddress
    MAC_ADDRESS
    Name
    NAME
    Password
    PASSWORD
    Phone
    PHONE
    Pin
    PIN
    SwiftCode
    SWIFT_CODE
    UkNationalHealthServiceNumber
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    UkNationalInsuranceNumber
    UK_NATIONAL_INSURANCE_NUMBER
    UkUniqueTaxpayerReferenceNumber
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    Url
    URL
    Username
    USERNAME
    UsBankAccountNumber
    US_BANK_ACCOUNT_NUMBER
    UsBankRoutingNumber
    US_BANK_ROUTING_NUMBER
    UsIndividualTaxIdentificationNumber
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    UsPassportNumber
    US_PASSPORT_NUMBER
    UsSocialSecurityNumber
    US_SOCIAL_SECURITY_NUMBER
    VehicleIdentificationNumber
    VEHICLE_IDENTIFICATION_NUMBER
    Address
    ADDRESS
    Age
    AGE
    AwsAccessKey
    AWS_ACCESS_KEY
    AwsSecretKey
    AWS_SECRET_KEY
    CaHealthNumber
    CA_HEALTH_NUMBER
    CaSocialInsuranceNumber
    CA_SOCIAL_INSURANCE_NUMBER
    CreditDebitCardCvv
    CREDIT_DEBIT_CARD_CVV
    CreditDebitCardExpiry
    CREDIT_DEBIT_CARD_EXPIRY
    CreditDebitCardNumber
    CREDIT_DEBIT_CARD_NUMBER
    DriverId
    DRIVER_ID
    Email
    EMAIL
    InternationalBankAccountNumber
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    IpAddress
    IP_ADDRESS
    LicensePlate
    LICENSE_PLATE
    MacAddress
    MAC_ADDRESS
    Name
    NAME
    Password
    PASSWORD
    Phone
    PHONE
    Pin
    PIN
    SwiftCode
    SWIFT_CODE
    UkNationalHealthServiceNumber
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    UkNationalInsuranceNumber
    UK_NATIONAL_INSURANCE_NUMBER
    UkUniqueTaxpayerReferenceNumber
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    Url
    URL
    Username
    USERNAME
    UsBankAccountNumber
    US_BANK_ACCOUNT_NUMBER
    UsBankRoutingNumber
    US_BANK_ROUTING_NUMBER
    UsIndividualTaxIdentificationNumber
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    UsPassportNumber
    US_PASSPORT_NUMBER
    UsSocialSecurityNumber
    US_SOCIAL_SECURITY_NUMBER
    VehicleIdentificationNumber
    VEHICLE_IDENTIFICATION_NUMBER
    ADDRESS
    ADDRESS
    AGE
    AGE
    AWS_ACCESS_KEY
    AWS_ACCESS_KEY
    AWS_SECRET_KEY
    AWS_SECRET_KEY
    CA_HEALTH_NUMBER
    CA_HEALTH_NUMBER
    CA_SOCIAL_INSURANCE_NUMBER
    CA_SOCIAL_INSURANCE_NUMBER
    CREDIT_DEBIT_CARD_CVV
    CREDIT_DEBIT_CARD_CVV
    CREDIT_DEBIT_CARD_EXPIRY
    CREDIT_DEBIT_CARD_EXPIRY
    CREDIT_DEBIT_CARD_NUMBER
    CREDIT_DEBIT_CARD_NUMBER
    DRIVER_ID
    DRIVER_ID
    EMAIL
    EMAIL
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    IP_ADDRESS
    IP_ADDRESS
    LICENSE_PLATE
    LICENSE_PLATE
    MAC_ADDRESS
    MAC_ADDRESS
    NAME
    NAME
    PASSWORD
    PASSWORD
    PHONE
    PHONE
    PIN
    PIN
    SWIFT_CODE
    SWIFT_CODE
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    UK_NATIONAL_INSURANCE_NUMBER
    UK_NATIONAL_INSURANCE_NUMBER
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    URL
    URL
    USERNAME
    USERNAME
    US_BANK_ACCOUNT_NUMBER
    US_BANK_ACCOUNT_NUMBER
    US_BANK_ROUTING_NUMBER
    US_BANK_ROUTING_NUMBER
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    US_PASSPORT_NUMBER
    US_PASSPORT_NUMBER
    US_SOCIAL_SECURITY_NUMBER
    US_SOCIAL_SECURITY_NUMBER
    VEHICLE_IDENTIFICATION_NUMBER
    VEHICLE_IDENTIFICATION_NUMBER
    "ADDRESS"
    ADDRESS
    "AGE"
    AGE
    "AWS_ACCESS_KEY"
    AWS_ACCESS_KEY
    "AWS_SECRET_KEY"
    AWS_SECRET_KEY
    "CA_HEALTH_NUMBER"
    CA_HEALTH_NUMBER
    "CA_SOCIAL_INSURANCE_NUMBER"
    CA_SOCIAL_INSURANCE_NUMBER
    "CREDIT_DEBIT_CARD_CVV"
    CREDIT_DEBIT_CARD_CVV
    "CREDIT_DEBIT_CARD_EXPIRY"
    CREDIT_DEBIT_CARD_EXPIRY
    "CREDIT_DEBIT_CARD_NUMBER"
    CREDIT_DEBIT_CARD_NUMBER
    "DRIVER_ID"
    DRIVER_ID
    "EMAIL"
    EMAIL
    "INTERNATIONAL_BANK_ACCOUNT_NUMBER"
    INTERNATIONAL_BANK_ACCOUNT_NUMBER
    "IP_ADDRESS"
    IP_ADDRESS
    "LICENSE_PLATE"
    LICENSE_PLATE
    "MAC_ADDRESS"
    MAC_ADDRESS
    "NAME"
    NAME
    "PASSWORD"
    PASSWORD
    "PHONE"
    PHONE
    "PIN"
    PIN
    "SWIFT_CODE"
    SWIFT_CODE
    "UK_NATIONAL_HEALTH_SERVICE_NUMBER"
    UK_NATIONAL_HEALTH_SERVICE_NUMBER
    "UK_NATIONAL_INSURANCE_NUMBER"
    UK_NATIONAL_INSURANCE_NUMBER
    "UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER"
    UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
    "URL"
    URL
    "USERNAME"
    USERNAME
    "US_BANK_ACCOUNT_NUMBER"
    US_BANK_ACCOUNT_NUMBER
    "US_BANK_ROUTING_NUMBER"
    US_BANK_ROUTING_NUMBER
    "US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER"
    US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
    "US_PASSPORT_NUMBER"
    US_PASSPORT_NUMBER
    "US_SOCIAL_SECURITY_NUMBER"
    US_SOCIAL_SECURITY_NUMBER
    "VEHICLE_IDENTIFICATION_NUMBER"
    VEHICLE_IDENTIFICATION_NUMBER

    GuardrailRegexConfig, GuardrailRegexConfigArgs

    Action Pulumi.AwsNative.Bedrock.GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    Action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    Name string
    The regex name.
    Pattern string
    The regex pattern.
    Description string
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name string
    The regex name.
    pattern string
    The regex pattern.
    description string
    The regex description.
    action GuardrailSensitiveInformationAction
    The guardrail action to configure when matching regular expression is detected.
    name str
    The regex name.
    pattern str
    The regex pattern.
    description str
    The regex description.
    action "BLOCK" | "ANONYMIZE"
    The guardrail action to configure when matching regular expression is detected.
    name String
    The regex name.
    pattern String
    The regex pattern.
    description String
    The regex description.

    GuardrailSensitiveInformationAction, GuardrailSensitiveInformationActionArgs

    Block
    BLOCK
    Anonymize
    ANONYMIZE
    GuardrailSensitiveInformationActionBlock
    BLOCK
    GuardrailSensitiveInformationActionAnonymize
    ANONYMIZE
    Block
    BLOCK
    Anonymize
    ANONYMIZE
    Block
    BLOCK
    Anonymize
    ANONYMIZE
    BLOCK
    BLOCK
    ANONYMIZE
    ANONYMIZE
    "BLOCK"
    BLOCK
    "ANONYMIZE"
    ANONYMIZE

    GuardrailSensitiveInformationPolicyConfig, GuardrailSensitiveInformationPolicyConfigArgs

    GuardrailStatus, GuardrailStatusArgs

    Creating
    CREATING
    Updating
    UPDATING
    Versioning
    VERSIONING
    Ready
    READY
    Failed
    FAILED
    Deleting
    DELETING
    GuardrailStatusCreating
    CREATING
    GuardrailStatusUpdating
    UPDATING
    GuardrailStatusVersioning
    VERSIONING
    GuardrailStatusReady
    READY
    GuardrailStatusFailed
    FAILED
    GuardrailStatusDeleting
    DELETING
    Creating
    CREATING
    Updating
    UPDATING
    Versioning
    VERSIONING
    Ready
    READY
    Failed
    FAILED
    Deleting
    DELETING
    Creating
    CREATING
    Updating
    UPDATING
    Versioning
    VERSIONING
    Ready
    READY
    Failed
    FAILED
    Deleting
    DELETING
    CREATING
    CREATING
    UPDATING
    UPDATING
    VERSIONING
    VERSIONING
    READY
    READY
    FAILED
    FAILED
    DELETING
    DELETING
    "CREATING"
    CREATING
    "UPDATING"
    UPDATING
    "VERSIONING"
    VERSIONING
    "READY"
    READY
    "FAILED"
    FAILED
    "DELETING"
    DELETING

    GuardrailTopicConfig, GuardrailTopicConfigArgs

    Definition string
    Definition of topic in topic policy
    Name string
    Name of topic in topic policy
    Type Pulumi.AwsNative.Bedrock.GuardrailTopicType
    Specifies to deny the topic.
    Examples List<string>
    List of text examples
    Definition string
    Definition of topic in topic policy
    Name string
    Name of topic in topic policy
    Type GuardrailTopicType
    Specifies to deny the topic.
    Examples []string
    List of text examples
    definition String
    Definition of topic in topic policy
    name String
    Name of topic in topic policy
    type GuardrailTopicType
    Specifies to deny the topic.
    examples List<String>
    List of text examples
    definition string
    Definition of topic in topic policy
    name string
    Name of topic in topic policy
    type GuardrailTopicType
    Specifies to deny the topic.
    examples string[]
    List of text examples
    definition str
    Definition of topic in topic policy
    name str
    Name of topic in topic policy
    type GuardrailTopicType
    Specifies to deny the topic.
    examples Sequence[str]
    List of text examples
    definition String
    Definition of topic in topic policy
    name String
    Name of topic in topic policy
    type "DENY"
    Specifies to deny the topic.
    examples List<String>
    List of text examples

    GuardrailTopicPolicyConfig, GuardrailTopicPolicyConfigArgs

    TopicsConfig []GuardrailTopicConfig
    List of topic configs in topic policy.
    topicsConfig List<GuardrailTopicConfig>
    List of topic configs in topic policy.
    topicsConfig GuardrailTopicConfig[]
    List of topic configs in topic policy.
    topics_config Sequence[GuardrailTopicConfig]
    List of topic configs in topic policy.
    topicsConfig List<Property Map>
    List of topic configs in topic policy.

    GuardrailTopicType, GuardrailTopicTypeArgs

    Deny
    DENY
    GuardrailTopicTypeDeny
    DENY
    Deny
    DENY
    Deny
    DENY
    DENY
    DENY
    "DENY"
    DENY

    GuardrailWordConfig, GuardrailWordConfigArgs

    Text string
    The custom word text.
    Text string
    The custom word text.
    text String
    The custom word text.
    text string
    The custom word text.
    text str
    The custom word text.
    text String
    The custom word text.

    GuardrailWordPolicyConfig, GuardrailWordPolicyConfigArgs

    ManagedWordListsConfig []GuardrailManagedWordsConfig
    A config for the list of managed words.
    WordsConfig []GuardrailWordConfig
    List of custom word configs.
    managedWordListsConfig List<GuardrailManagedWordsConfig>
    A config for the list of managed words.
    wordsConfig List<GuardrailWordConfig>
    List of custom word configs.
    managedWordListsConfig GuardrailManagedWordsConfig[]
    A config for the list of managed words.
    wordsConfig GuardrailWordConfig[]
    List of custom word configs.
    managed_word_lists_config Sequence[GuardrailManagedWordsConfig]
    A config for the list of managed words.
    words_config Sequence[GuardrailWordConfig]
    List of custom word configs.
    managedWordListsConfig List<Property Map>
    A config for the list of managed words.
    wordsConfig List<Property Map>
    List of custom word configs.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi