AWS::Wisdom::AIGuardrail - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Wisdom::AIGuardrail

Creates an Amazon Q in Connect AI Guardrail.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

Properties

AssistantId

The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Required: Yes

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$

Update requires: Replacement

BlockedInputMessaging

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

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: No interruption

BlockedOutputsMessaging

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

Required: Yes

Type: String

Minimum: 1

Maximum: 500

Update requires: No interruption

ContentPolicyConfig

Contains details about how to handle harmful content.

Required: No

Type: AIGuardrailContentPolicyConfig

Update requires: No interruption

ContextualGroundingPolicyConfig

The policy configuration details for the AI Guardrail's contextual grounding policy.

Required: No

Type: AIGuardrailContextualGroundingPolicyConfig

Update requires: No interruption

Description

A description of the AI Guardrail.

Required: No

Type: String

Minimum: 1

Maximum: 200

Update requires: No interruption

Name

The name of the AI Guardrail.

Required: No

Type: String

Pattern: ^[a-zA-Z0-9\s_.,-]+

Minimum: 1

Maximum: 255

Update requires: Replacement

SensitiveInformationPolicyConfig

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

Required: No

Type: AIGuardrailSensitiveInformationPolicyConfig

Update requires: No interruption

Tags

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

Required: No

Type: Object of String

Pattern: ^(?!aws:)[a-zA-Z+-=._:/]+$

Minimum: 1

Maximum: 256

Update requires: Replacement

TopicPolicyConfig

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

Required: No

Type: AIGuardrailTopicPolicyConfig

Update requires: No interruption

WordPolicyConfig

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

Required: No

Type: AIGuardrailWordPolicyConfig

Update requires: No interruption

Return values

Ref

Fn::GetAtt

AIGuardrailArn

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

AIGuardrailId

The identifier of the Amazon Q in Connect AI Guardrail.

AssistantArn

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