AWS Cloud Control v1.24.0, Jan 15 25

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.wisdom.AiGuardrail

Explore with Pulumi AI

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

pulumi/pulumi-aws-native

Create AiGuardrail Resource

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

Constructor syntax

new AiGuardrail(name: string, args: AiGuardrailArgs, opts?: CustomResourceOptions);

@overload
def AiGuardrail(resource_name: str,
                args: AiGuardrailArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def AiGuardrail(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                assistant_id: Optional[str] = None,
                blocked_input_messaging: Optional[str] = None,
                blocked_outputs_messaging: Optional[str] = None,
                content_policy_config: Optional[AiGuardrailAiGuardrailContentPolicyConfigArgs] = None,
                contextual_grounding_policy_config: Optional[AiGuardrailAiGuardrailContextualGroundingPolicyConfigArgs] = None,
                description: Optional[str] = None,
                name: Optional[str] = None,
                sensitive_information_policy_config: Optional[AiGuardrailAiGuardrailSensitiveInformationPolicyConfigArgs] = None,
                tags: Optional[Mapping[str, str]] = None,
                topic_policy_config: Optional[AiGuardrailAiGuardrailTopicPolicyConfigArgs] = None,
                word_policy_config: Optional[AiGuardrailAiGuardrailWordPolicyConfigArgs] = None)

func NewAiGuardrail(ctx *Context, name string, args AiGuardrailArgs, opts ...ResourceOption) (*AiGuardrail, error)

public AiGuardrail(string name, AiGuardrailArgs args, CustomResourceOptions? opts = null)

public AiGuardrail(String name, AiGuardrailArgs args)
public AiGuardrail(String name, AiGuardrailArgs args, CustomResourceOptions options)

type: aws-native:wisdom:AiGuardrail
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 AiGuardrailArgs: 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 AiGuardrailArgs: 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 AiGuardrailArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args AiGuardrailArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args AiGuardrailArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

AiGuardrail 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 AiGuardrail resource accepts the following input properties:

AssistantId string: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
BlockedInputMessaging string: Messaging for when violations are detected in text
BlockedOutputsMessaging string: Messaging for when violations are detected in text
ContentPolicyConfig Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailAiGuardrailContentPolicyConfig: Contains details about how to handle harmful content.
ContextualGroundingPolicyConfig Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailAiGuardrailContextualGroundingPolicyConfig: The policy configuration details for the AI Guardrail's contextual grounding policy.
Description string: Description of the guardrail or its version
Name string: The name of the AI Guardrail.
SensitiveInformationPolicyConfig Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailAiGuardrailSensitiveInformationPolicyConfig: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Tags Dictionary<string, string>: The tags used to organize, track, or control access for this resource.
TopicPolicyConfig Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailAiGuardrailTopicPolicyConfig: Contains details about topics that the AI Guardrail should identify and deny.
WordPolicyConfig Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailAiGuardrailWordPolicyConfig: Contains details about the word policy to configured for the AI Guardrail.

AssistantId string: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
BlockedInputMessaging string: Messaging for when violations are detected in text
BlockedOutputsMessaging string: Messaging for when violations are detected in text
ContentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfigArgs: Contains details about how to handle harmful content.
ContextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfigArgs: The policy configuration details for the AI Guardrail's contextual grounding policy.
Description string: Description of the guardrail or its version
Name string: The name of the AI Guardrail.
SensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfigArgs: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
Tags map[string]string: The tags used to organize, track, or control access for this resource.
TopicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfigArgs: Contains details about topics that the AI Guardrail should identify and deny.
WordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfigArgs: Contains details about the word policy to configured for the AI Guardrail.

assistantId String: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
blockedInputMessaging String: Messaging for when violations are detected in text
blockedOutputsMessaging String: Messaging for when violations are detected in text
contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig: Contains details about how to handle harmful content.
contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig: The policy configuration details for the AI Guardrail's contextual grounding policy.
description String: Description of the guardrail or its version
name String: The name of the AI Guardrail.
sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags Map<String,String>: The tags used to organize, track, or control access for this resource.
topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig: Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig: Contains details about the word policy to configured for the AI Guardrail.

assistantId string: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
blockedInputMessaging string: Messaging for when violations are detected in text
blockedOutputsMessaging string: Messaging for when violations are detected in text
contentPolicyConfig AiGuardrailAiGuardrailContentPolicyConfig: Contains details about how to handle harmful content.
contextualGroundingPolicyConfig AiGuardrailAiGuardrailContextualGroundingPolicyConfig: The policy configuration details for the AI Guardrail's contextual grounding policy.
description string: Description of the guardrail or its version
name string: The name of the AI Guardrail.
sensitiveInformationPolicyConfig AiGuardrailAiGuardrailSensitiveInformationPolicyConfig: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags {[key: string]: string}: The tags used to organize, track, or control access for this resource.
topicPolicyConfig AiGuardrailAiGuardrailTopicPolicyConfig: Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig AiGuardrailAiGuardrailWordPolicyConfig: Contains details about the word policy to configured for the AI Guardrail.

assistant_id str: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
blocked_input_messaging str: Messaging for when violations are detected in text
blocked_outputs_messaging str: Messaging for when violations are detected in text
content_policy_config AiGuardrailAiGuardrailContentPolicyConfigArgs: Contains details about how to handle harmful content.
contextual_grounding_policy_config AiGuardrailAiGuardrailContextualGroundingPolicyConfigArgs: The policy configuration details for the AI Guardrail's contextual grounding policy.
description str: Description of the guardrail or its version
name str: The name of the AI Guardrail.
sensitive_information_policy_config AiGuardrailAiGuardrailSensitiveInformationPolicyConfigArgs: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags Mapping[str, str]: The tags used to organize, track, or control access for this resource.
topic_policy_config AiGuardrailAiGuardrailTopicPolicyConfigArgs: Contains details about topics that the AI Guardrail should identify and deny.
word_policy_config AiGuardrailAiGuardrailWordPolicyConfigArgs: Contains details about the word policy to configured for the AI Guardrail.

assistantId String: The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.
blockedInputMessaging String: Messaging for when violations are detected in text
blockedOutputsMessaging String: Messaging for when violations are detected in text
contentPolicyConfig Property Map: Contains details about how to handle harmful content.
contextualGroundingPolicyConfig Property Map: The policy configuration details for the AI Guardrail's contextual grounding policy.
description String: Description of the guardrail or its version
name String: The name of the AI Guardrail.
sensitiveInformationPolicyConfig Property Map: Contains details about PII entities and regular expressions to configure for the AI Guardrail.
tags Map<String>: The tags used to organize, track, or control access for this resource.
topicPolicyConfig Property Map: Contains details about topics that the AI Guardrail should identify and deny.
wordPolicyConfig Property Map: Contains details about the word policy to configured for the AI Guardrail.

Outputs

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

AiGuardrailArn string: The Amazon Resource Name (ARN) of the AI Guardrail.
AiGuardrailId string: The identifier of the Amazon Q in Connect AI Guardrail.
AssistantArn string: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Id string: The provider-assigned unique ID for this managed resource.

AiGuardrailArn string: The Amazon Resource Name (ARN) of the AI Guardrail.
AiGuardrailId string: The identifier of the Amazon Q in Connect AI Guardrail.
AssistantArn string: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
Id string: The provider-assigned unique ID for this managed resource.

aiGuardrailArn String: The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId String: The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn String: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id String: The provider-assigned unique ID for this managed resource.

aiGuardrailArn string: The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId string: The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn string: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id string: The provider-assigned unique ID for this managed resource.

ai_guardrail_arn str: The Amazon Resource Name (ARN) of the AI Guardrail.
ai_guardrail_id str: The identifier of the Amazon Q in Connect AI Guardrail.
assistant_arn str: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id str: The provider-assigned unique ID for this managed resource.

aiGuardrailArn String: The Amazon Resource Name (ARN) of the AI Guardrail.
aiGuardrailId String: The identifier of the Amazon Q in Connect AI Guardrail.
assistantArn String: The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
id String: The provider-assigned unique ID for this managed resource.

Supporting Types

AiGuardrailAiGuardrailContentPolicyConfig, AiGuardrailAiGuardrailContentPolicyConfigArgs

FiltersConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailContentFilterConfig>: List of content filter configs in content policy.

FiltersConfig []AiGuardrailGuardrailContentFilterConfig: List of content filter configs in content policy.

filtersConfig List<AiGuardrailGuardrailContentFilterConfig>: List of content filter configs in content policy.

filtersConfig AiGuardrailGuardrailContentFilterConfig[]: List of content filter configs in content policy.

filters_config Sequence[AiGuardrailGuardrailContentFilterConfig]: List of content filter configs in content policy.

filtersConfig List<Property Map>: List of content filter configs in content policy.

AiGuardrailAiGuardrailContextualGroundingPolicyConfig, AiGuardrailAiGuardrailContextualGroundingPolicyConfigArgs

FiltersConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailContextualGroundingFilterConfig>: List of contextual grounding filter configs.

FiltersConfig []AiGuardrailGuardrailContextualGroundingFilterConfig: List of contextual grounding filter configs.

filtersConfig List<AiGuardrailGuardrailContextualGroundingFilterConfig>: List of contextual grounding filter configs.

filtersConfig AiGuardrailGuardrailContextualGroundingFilterConfig[]: List of contextual grounding filter configs.

filters_config Sequence[AiGuardrailGuardrailContextualGroundingFilterConfig]: List of contextual grounding filter configs.

filtersConfig List<Property Map>: List of contextual grounding filter configs.

AiGuardrailAiGuardrailSensitiveInformationPolicyConfig, AiGuardrailAiGuardrailSensitiveInformationPolicyConfigArgs

PiiEntitiesConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailPiiEntityConfig>: List of entities.
RegexesConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailRegexConfig>: List of regex.

PiiEntitiesConfig []AiGuardrailGuardrailPiiEntityConfig: List of entities.
RegexesConfig []AiGuardrailGuardrailRegexConfig: List of regex.

piiEntitiesConfig List<AiGuardrailGuardrailPiiEntityConfig>: List of entities.
regexesConfig List<AiGuardrailGuardrailRegexConfig>: List of regex.

piiEntitiesConfig AiGuardrailGuardrailPiiEntityConfig[]: List of entities.
regexesConfig AiGuardrailGuardrailRegexConfig[]: List of regex.

pii_entities_config Sequence[AiGuardrailGuardrailPiiEntityConfig]: List of entities.
regexes_config Sequence[AiGuardrailGuardrailRegexConfig]: List of regex.

piiEntitiesConfig List<Property Map>: List of entities.
regexesConfig List<Property Map>: List of regex.

AiGuardrailAiGuardrailTopicPolicyConfig, AiGuardrailAiGuardrailTopicPolicyConfigArgs

TopicsConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailTopicConfig>: List of topic configs in topic policy.

TopicsConfig []AiGuardrailGuardrailTopicConfig: List of topic configs in topic policy.

topicsConfig List<AiGuardrailGuardrailTopicConfig>: List of topic configs in topic policy.

topicsConfig AiGuardrailGuardrailTopicConfig[]: List of topic configs in topic policy.

topics_config Sequence[AiGuardrailGuardrailTopicConfig]: List of topic configs in topic policy.

topicsConfig List<Property Map>: List of topic configs in topic policy.

AiGuardrailAiGuardrailWordPolicyConfig, AiGuardrailAiGuardrailWordPolicyConfigArgs

ManagedWordListsConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailManagedWordsConfig>: A config for the list of managed words.
WordsConfig List<Pulumi.AwsNative.Wisdom.Inputs.AiGuardrailGuardrailWordConfig>: List of custom word configs.

ManagedWordListsConfig []AiGuardrailGuardrailManagedWordsConfig: A config for the list of managed words.
WordsConfig []AiGuardrailGuardrailWordConfig: List of custom word configs.

managedWordListsConfig List<AiGuardrailGuardrailManagedWordsConfig>: A config for the list of managed words.
wordsConfig List<AiGuardrailGuardrailWordConfig>: List of custom word configs.

managedWordListsConfig AiGuardrailGuardrailManagedWordsConfig[]: A config for the list of managed words.
wordsConfig AiGuardrailGuardrailWordConfig[]: List of custom word configs.

managed_word_lists_config Sequence[AiGuardrailGuardrailManagedWordsConfig]: A config for the list of managed words.
words_config Sequence[AiGuardrailGuardrailWordConfig]: 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.

AiGuardrailGuardrailContentFilterConfig, AiGuardrailGuardrailContentFilterConfigArgs

InputStrength Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength: The strength of the input for the guardrail content filter.
OutputStrength Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailFilterStrength: The output strength of the guardrail content filter.
Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContentFilterType: The type of the guardrail content filter.

InputStrength AiGuardrailGuardrailFilterStrength: The strength of the input for the guardrail content filter.
OutputStrength AiGuardrailGuardrailFilterStrength: The output strength of the guardrail content filter.
Type AiGuardrailGuardrailContentFilterType: The type of the guardrail content filter.

inputStrength AiGuardrailGuardrailFilterStrength: The strength of the input for the guardrail content filter.
outputStrength AiGuardrailGuardrailFilterStrength: The output strength of the guardrail content filter.
type AiGuardrailGuardrailContentFilterType: The type of the guardrail content filter.

inputStrength AiGuardrailGuardrailFilterStrength: The strength of the input for the guardrail content filter.
outputStrength AiGuardrailGuardrailFilterStrength: The output strength of the guardrail content filter.
type AiGuardrailGuardrailContentFilterType: The type of the guardrail content filter.

input_strength AiGuardrailGuardrailFilterStrength: The strength of the input for the guardrail content filter.
output_strength AiGuardrailGuardrailFilterStrength: The output strength of the guardrail content filter.
type AiGuardrailGuardrailContentFilterType: The type of the guardrail content filter.

inputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH": The strength of the input for the guardrail content filter.
outputStrength "NONE" | "LOW" | "MEDIUM" | "HIGH": The output strength of the guardrail content filter.
type "SEXUAL" | "VIOLENCE" | "HATE" | "INSULTS" | "MISCONDUCT" | "PROMPT_ATTACK": The type of the guardrail content filter.

AiGuardrailGuardrailContentFilterType, AiGuardrailGuardrailContentFilterTypeArgs

Sexual: SEXUAL
Violence: VIOLENCE
Hate: HATE
Insults: INSULTS
Misconduct: MISCONDUCT
PromptAttack: PROMPT_ATTACK

AiGuardrailGuardrailContentFilterTypeSexual: SEXUAL
AiGuardrailGuardrailContentFilterTypeViolence: VIOLENCE
AiGuardrailGuardrailContentFilterTypeHate: HATE
AiGuardrailGuardrailContentFilterTypeInsults: INSULTS
AiGuardrailGuardrailContentFilterTypeMisconduct: MISCONDUCT
AiGuardrailGuardrailContentFilterTypePromptAttack: 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

AiGuardrailGuardrailContextualGroundingFilterConfig, AiGuardrailGuardrailContextualGroundingFilterConfigArgs

Threshold double: The threshold for this filter.
Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailContextualGroundingFilterType: The type of this filter.

Threshold float64: The threshold for this filter.
Type AiGuardrailGuardrailContextualGroundingFilterType: The type of this filter.

threshold Double: The threshold for this filter.
type AiGuardrailGuardrailContextualGroundingFilterType: The type of this filter.

threshold number: The threshold for this filter.
type AiGuardrailGuardrailContextualGroundingFilterType: The type of this filter.

threshold float: The threshold for this filter.
type AiGuardrailGuardrailContextualGroundingFilterType: The type of this filter.

threshold Number: The threshold for this filter.
type "GROUNDING" | "RELEVANCE": The type of this filter.

AiGuardrailGuardrailContextualGroundingFilterType, AiGuardrailGuardrailContextualGroundingFilterTypeArgs

Grounding: GROUNDING
Relevance: RELEVANCE

AiGuardrailGuardrailContextualGroundingFilterTypeGrounding: GROUNDING
AiGuardrailGuardrailContextualGroundingFilterTypeRelevance: RELEVANCE

Grounding: GROUNDING
Relevance: RELEVANCE

Grounding: GROUNDING
Relevance: RELEVANCE

GROUNDING: GROUNDING
RELEVANCE: RELEVANCE

"GROUNDING": GROUNDING
"RELEVANCE": RELEVANCE

AiGuardrailGuardrailFilterStrength, AiGuardrailGuardrailFilterStrengthArgs

None: NONE
Low: LOW
Medium: MEDIUM
High: HIGH

AiGuardrailGuardrailFilterStrengthNone: NONE
AiGuardrailGuardrailFilterStrengthLow: LOW
AiGuardrailGuardrailFilterStrengthMedium: MEDIUM
AiGuardrailGuardrailFilterStrengthHigh: 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

AiGuardrailGuardrailManagedWordsConfig, AiGuardrailGuardrailManagedWordsConfigArgs

Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailManagedWordsType: The type of guardrail managed words.

Type AiGuardrailGuardrailManagedWordsType: The type of guardrail managed words.

type AiGuardrailGuardrailManagedWordsType: The type of guardrail managed words.

type AiGuardrailGuardrailManagedWordsType: The type of guardrail managed words.

type AiGuardrailGuardrailManagedWordsType: The type of guardrail managed words.

type "PROFANITY": The type of guardrail managed words.

AiGuardrailGuardrailManagedWordsType, AiGuardrailGuardrailManagedWordsTypeArgs

Profanity: PROFANITY

AiGuardrailGuardrailManagedWordsTypeProfanity: PROFANITY

Profanity: PROFANITY

Profanity: PROFANITY

PROFANITY: PROFANITY

"PROFANITY": PROFANITY

AiGuardrailGuardrailPiiEntityConfig, AiGuardrailGuardrailPiiEntityConfigArgs

Action Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction: The action of guardrail PII entity configuration.
Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailPiiEntityType

Action AiGuardrailGuardrailSensitiveInformationAction: The action of guardrail PII entity configuration.
Type AiGuardrailGuardrailPiiEntityType

action AiGuardrailGuardrailSensitiveInformationAction: The action of guardrail PII entity configuration.
type AiGuardrailGuardrailPiiEntityType

action AiGuardrailGuardrailSensitiveInformationAction: The action of guardrail PII entity configuration.
type AiGuardrailGuardrailPiiEntityType

action AiGuardrailGuardrailSensitiveInformationAction: The action of guardrail PII entity configuration.
type AiGuardrailGuardrailPiiEntityType

action "BLOCK" | "ANONYMIZE": The action of guardrail PII entity configuration.
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"

AiGuardrailGuardrailPiiEntityType, AiGuardrailGuardrailPiiEntityTypeArgs

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

AiGuardrailGuardrailPiiEntityTypeAddress: ADDRESS
AiGuardrailGuardrailPiiEntityTypeAge: AGE
AiGuardrailGuardrailPiiEntityTypeAwsAccessKey: AWS_ACCESS_KEY
AiGuardrailGuardrailPiiEntityTypeAwsSecretKey: AWS_SECRET_KEY
AiGuardrailGuardrailPiiEntityTypeCaHealthNumber: CA_HEALTH_NUMBER
AiGuardrailGuardrailPiiEntityTypeCaSocialInsuranceNumber: CA_SOCIAL_INSURANCE_NUMBER
AiGuardrailGuardrailPiiEntityTypeCreditDebitCardCvv: CREDIT_DEBIT_CARD_CVV
AiGuardrailGuardrailPiiEntityTypeCreditDebitCardExpiry: CREDIT_DEBIT_CARD_EXPIRY
AiGuardrailGuardrailPiiEntityTypeCreditDebitCardNumber: CREDIT_DEBIT_CARD_NUMBER
AiGuardrailGuardrailPiiEntityTypeDriverId: DRIVER_ID
AiGuardrailGuardrailPiiEntityTypeEmail: EMAIL
AiGuardrailGuardrailPiiEntityTypeInternationalBankAccountNumber: INTERNATIONAL_BANK_ACCOUNT_NUMBER
AiGuardrailGuardrailPiiEntityTypeIpAddress: IP_ADDRESS
AiGuardrailGuardrailPiiEntityTypeLicensePlate: LICENSE_PLATE
AiGuardrailGuardrailPiiEntityTypeMacAddress: MAC_ADDRESS
AiGuardrailGuardrailPiiEntityTypeName: NAME
AiGuardrailGuardrailPiiEntityTypePassword: PASSWORD
AiGuardrailGuardrailPiiEntityTypePhone: PHONE
AiGuardrailGuardrailPiiEntityTypePin: PIN
AiGuardrailGuardrailPiiEntityTypeSwiftCode: SWIFT_CODE
AiGuardrailGuardrailPiiEntityTypeUkNationalHealthServiceNumber: UK_NATIONAL_HEALTH_SERVICE_NUMBER
AiGuardrailGuardrailPiiEntityTypeUkNationalInsuranceNumber: UK_NATIONAL_INSURANCE_NUMBER
AiGuardrailGuardrailPiiEntityTypeUkUniqueTaxpayerReferenceNumber: UK_UNIQUE_TAXPAYER_REFERENCE_NUMBER
AiGuardrailGuardrailPiiEntityTypeUrl: URL
AiGuardrailGuardrailPiiEntityTypeUsername: USERNAME
AiGuardrailGuardrailPiiEntityTypeUsBankAccountNumber: US_BANK_ACCOUNT_NUMBER
AiGuardrailGuardrailPiiEntityTypeUsBankRoutingNumber: US_BANK_ROUTING_NUMBER
AiGuardrailGuardrailPiiEntityTypeUsIndividualTaxIdentificationNumber: US_INDIVIDUAL_TAX_IDENTIFICATION_NUMBER
AiGuardrailGuardrailPiiEntityTypeUsPassportNumber: US_PASSPORT_NUMBER
AiGuardrailGuardrailPiiEntityTypeUsSocialSecurityNumber: US_SOCIAL_SECURITY_NUMBER
AiGuardrailGuardrailPiiEntityTypeVehicleIdentificationNumber: 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

AiGuardrailGuardrailRegexConfig, AiGuardrailGuardrailRegexConfigArgs

Action Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailSensitiveInformationAction: The action of the guardrail regex configuration.
Name string: The regex name.
Pattern string: The regex pattern.
Description string: The regex description.

Action AiGuardrailGuardrailSensitiveInformationAction: The action of the guardrail regex configuration.
Name string: The regex name.
Pattern string: The regex pattern.
Description string: The regex description.

action AiGuardrailGuardrailSensitiveInformationAction: The action of the guardrail regex configuration.
name String: The regex name.
pattern String: The regex pattern.
description String: The regex description.

action AiGuardrailGuardrailSensitiveInformationAction: The action of the guardrail regex configuration.
name string: The regex name.
pattern string: The regex pattern.
description string: The regex description.

action AiGuardrailGuardrailSensitiveInformationAction: The action of the guardrail regex configuration.
name str: The regex name.
pattern str: The regex pattern.
description str: The regex description.

action "BLOCK" | "ANONYMIZE": The action of the guardrail regex configuration.
name String: The regex name.
pattern String: The regex pattern.
description String: The regex description.

AiGuardrailGuardrailSensitiveInformationAction, AiGuardrailGuardrailSensitiveInformationActionArgs

Block: BLOCK
Anonymize: ANONYMIZE

AiGuardrailGuardrailSensitiveInformationActionBlock: BLOCK
AiGuardrailGuardrailSensitiveInformationActionAnonymize: ANONYMIZE

Block: BLOCK
Anonymize: ANONYMIZE

Block: BLOCK
Anonymize: ANONYMIZE

BLOCK: BLOCK
ANONYMIZE: ANONYMIZE

"BLOCK": BLOCK
"ANONYMIZE": ANONYMIZE

AiGuardrailGuardrailTopicConfig, AiGuardrailGuardrailTopicConfigArgs

Definition string: Definition of topic in topic policy
Name string: Name of topic in topic policy
Type Pulumi.AwsNative.Wisdom.AiGuardrailGuardrailTopicType: Type of topic in a policy.
Examples List<string>: List of text examples

Definition string: Definition of topic in topic policy
Name string: Name of topic in topic policy
Type AiGuardrailGuardrailTopicType: Type of topic in a policy.
Examples []string: List of text examples

definition String: Definition of topic in topic policy
name String: Name of topic in topic policy
type AiGuardrailGuardrailTopicType: Type of topic in a policy.
examples List<String>: List of text examples

definition string: Definition of topic in topic policy
name string: Name of topic in topic policy
type AiGuardrailGuardrailTopicType: Type of topic in a policy.
examples string[]: List of text examples

definition str: Definition of topic in topic policy
name str: Name of topic in topic policy
type AiGuardrailGuardrailTopicType: Type of topic in a policy.
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": Type of topic in a policy.
examples List<String>: List of text examples

AiGuardrailGuardrailTopicType, AiGuardrailGuardrailTopicTypeArgs

Deny: DENY

AiGuardrailGuardrailTopicTypeDeny: DENY

Deny: DENY

Deny: DENY

DENY: DENY

"DENY": DENY

AiGuardrailGuardrailWordConfig, AiGuardrailGuardrailWordConfigArgs

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.

Package Details

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

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

AWS Cloud Control v1.24.0 published on Wednesday, Jan 15, 2025 by Pulumi

pulumi/pulumi-aws-native

aws-native.wisdom.AiGuardrail

On this page

On this page

Create AiGuardrail Resource

Constructor syntax

Parameters

AiGuardrail Resource Properties

Inputs

Outputs

Supporting Types

AiGuardrailAiGuardrailContentPolicyConfig, AiGuardrailAiGuardrailContentPolicyConfigArgs

AiGuardrailAiGuardrailContextualGroundingPolicyConfig, AiGuardrailAiGuardrailContextualGroundingPolicyConfigArgs

AiGuardrailAiGuardrailSensitiveInformationPolicyConfig, AiGuardrailAiGuardrailSensitiveInformationPolicyConfigArgs

AiGuardrailAiGuardrailTopicPolicyConfig, AiGuardrailAiGuardrailTopicPolicyConfigArgs

AiGuardrailAiGuardrailWordPolicyConfig, AiGuardrailAiGuardrailWordPolicyConfigArgs

AiGuardrailGuardrailContentFilterConfig, AiGuardrailGuardrailContentFilterConfigArgs

AiGuardrailGuardrailContentFilterType, AiGuardrailGuardrailContentFilterTypeArgs

AiGuardrailGuardrailContextualGroundingFilterConfig, AiGuardrailGuardrailContextualGroundingFilterConfigArgs

AiGuardrailGuardrailContextualGroundingFilterType, AiGuardrailGuardrailContextualGroundingFilterTypeArgs

AiGuardrailGuardrailFilterStrength, AiGuardrailGuardrailFilterStrengthArgs

AiGuardrailGuardrailManagedWordsConfig, AiGuardrailGuardrailManagedWordsConfigArgs

AiGuardrailGuardrailManagedWordsType, AiGuardrailGuardrailManagedWordsTypeArgs

AiGuardrailGuardrailPiiEntityConfig, AiGuardrailGuardrailPiiEntityConfigArgs

AiGuardrailGuardrailPiiEntityType, AiGuardrailGuardrailPiiEntityTypeArgs

AiGuardrailGuardrailRegexConfig, AiGuardrailGuardrailRegexConfigArgs

AiGuardrailGuardrailSensitiveInformationAction, AiGuardrailGuardrailSensitiveInformationActionArgs

AiGuardrailGuardrailTopicConfig, AiGuardrailGuardrailTopicConfigArgs

AiGuardrailGuardrailTopicType, AiGuardrailGuardrailTopicTypeArgs

AiGuardrailGuardrailWordConfig, AiGuardrailGuardrailWordConfigArgs

Package Details

On this page

On this page