Class CfnAIGuardrailProps

Properties for defining a CfnAIGuardrail.

Inheritance
System.Object
CfnAIGuardrailProps
Namespace: Amazon.CDK.AWS.Wisdom
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAIGuardrailProps : Object, ICfnAIGuardrailProps
Syntax (vb)
Public Class CfnAIGuardrailProps
    Inherits Object
    Implements ICfnAIGuardrailProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.Wisdom;

var cfnAIGuardrailProps = new CfnAIGuardrailProps {
    AssistantId = "assistantId",
    BlockedInputMessaging = "blockedInputMessaging",
    BlockedOutputsMessaging = "blockedOutputsMessaging",

    // the properties below are optional
    ContentPolicyConfig = new AIGuardrailContentPolicyConfigProperty {
        FiltersConfig = new [] { new GuardrailContentFilterConfigProperty {
            InputStrength = "inputStrength",
            OutputStrength = "outputStrength",
            Type = "type"
        } }
    },
    ContextualGroundingPolicyConfig = new AIGuardrailContextualGroundingPolicyConfigProperty {
        FiltersConfig = new [] { new GuardrailContextualGroundingFilterConfigProperty {
            Threshold = 123,
            Type = "type"
        } }
    },
    Description = "description",
    Name = "name",
    SensitiveInformationPolicyConfig = new AIGuardrailSensitiveInformationPolicyConfigProperty {
        PiiEntitiesConfig = new [] { new GuardrailPiiEntityConfigProperty {
            Action = "action",
            Type = "type"
        } },
        RegexesConfig = new [] { new GuardrailRegexConfigProperty {
            Action = "action",
            Name = "name",
            Pattern = "pattern",

            // the properties below are optional
            Description = "description"
        } }
    },
    Tags = new Dictionary<string, string> {
        { "tagsKey", "tags" }
    },
    TopicPolicyConfig = new AIGuardrailTopicPolicyConfigProperty {
        TopicsConfig = new [] { new GuardrailTopicConfigProperty {
            Definition = "definition",
            Name = "name",
            Type = "type",

            // the properties below are optional
            Examples = new [] { "examples" }
        } }
    },
    WordPolicyConfig = new AIGuardrailWordPolicyConfigProperty {
        ManagedWordListsConfig = new [] { new GuardrailManagedWordsConfigProperty {
            Type = "type"
        } },
        WordsConfig = new [] { new GuardrailWordConfigProperty {
            Text = "text"
        } }
    }
};

Synopsis

Constructors

CfnAIGuardrailProps()

Properties

AssistantId

The identifier of the Amazon Q in Connect assistant.
BlockedInputMessaging

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

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

Contains details about how to handle harmful content.
ContextualGroundingPolicyConfig

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

A description of the AI Guardrail.
Name

The name of the AI Guardrail.
SensitiveInformationPolicyConfig

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

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

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

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

Constructors

CfnAIGuardrailProps()

public CfnAIGuardrailProps()

Properties

AssistantId

The identifier of the Amazon Q in Connect assistant.

public string AssistantId { get; set; }
Property Value

System.String

Remarks

Can be either the ID or the ARN. URLs cannot contain the ARN.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-assistantid

BlockedInputMessaging

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

public string BlockedInputMessaging { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-blockedinputmessaging

BlockedOutputsMessaging

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

public string BlockedOutputsMessaging { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-blockedoutputsmessaging

ContentPolicyConfig

Contains details about how to handle harmful content.

public object ContentPolicyConfig { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-contentpolicyconfig

ContextualGroundingPolicyConfig

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

public object ContextualGroundingPolicyConfig { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-contextualgroundingpolicyconfig

Description

A description of the AI Guardrail.

public string Description { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-description

Name

The name of the AI Guardrail.

public string Name { get; set; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-name

SensitiveInformationPolicyConfig

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

public object SensitiveInformationPolicyConfig { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-sensitiveinformationpolicyconfig

Tags

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

public IDictionary<string, string> Tags { get; set; }
Property Value

System.Collections.Generic.IDictionary<System.String, System.String>

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-tags

TopicPolicyConfig

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

public object TopicPolicyConfig { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-topicpolicyconfig

WordPolicyConfig

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

public object WordPolicyConfig { get; set; }
Property Value

System.Object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-wordpolicyconfig

Implements