AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::Wisdom::AIGuardrail

CfnAIGuardrail

Creates an Amazon Q in Connect AI Guardrail.

Import

import { CfnAIGuardrail } from 'aws-cdk-lib/aws-wisdom';

Or use the module namespace:

import * as wisdom from 'aws-cdk-lib/aws-wisdom';
// wisdom.CfnAIGuardrail

Properties

Configuration passed to the constructor as CfnAIGuardrailProps.

assistantIdRequired
string

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

blockedInputMessagingRequired
string

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

blockedOutputsMessagingRequired
string

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

contentPolicyConfigOptional
IResolvable | AIGuardrailContentPolicyConfigProperty

Contains details about how to handle harmful content.

contextualGroundingPolicyConfigOptional
IResolvable | AIGuardrailContextualGroundingPolicyConfigProperty

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

descriptionOptional
string

A description of the AI Guardrail.

nameOptional
string

The name of the AI Guardrail.

sensitiveInformationPolicyConfigOptional
IResolvable | AIGuardrailSensitiveInformationPolicyConfigProperty

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

tagsOptional
{ [key: string]: string }

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

topicPolicyConfigOptional
IResolvable | AIGuardrailTopicPolicyConfigProperty

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

wordPolicyConfigOptional
IResolvable | AIGuardrailWordPolicyConfigProperty

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::Wisdom::AIGuardrailView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)
Moduleaws-wisdom
CFN TypeAWS::Wisdom::AIGuardrail
Properties11

Related Constructs

Explore This Service

External Links