Interface ICfnGuardrailProps

Properties for defining a CfnGuardrail.

Namespace: Amazon.CDK.AwsBedrock
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnGuardrailProps
Syntax (vb)
Public Interface ICfnGuardrailProps
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.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_bedrock;

var cfnGuardrailProps = new CfnGuardrailProps {
    BlockedInputMessaging = "blockedInputMessaging",
    BlockedOutputsMessaging = "blockedOutputsMessaging",
    Name = "name",

    // the properties below are optional
    ContentPolicyConfig = new ContentPolicyConfigProperty {
        FiltersConfig = new [] { new ContentFilterConfigProperty {
            InputStrength = "inputStrength",
            OutputStrength = "outputStrength",
            Type = "type"
        } }
    },
    ContextualGroundingPolicyConfig = new ContextualGroundingPolicyConfigProperty {
        FiltersConfig = new [] { new ContextualGroundingFilterConfigProperty {
            Threshold = 123,
            Type = "type"
        } }
    },
    Description = "description",
    KmsKeyArn = "kmsKeyArn",
    SensitiveInformationPolicyConfig = new SensitiveInformationPolicyConfigProperty {
        PiiEntitiesConfig = new [] { new PiiEntityConfigProperty {
            Action = "action",
            Type = "type"
        } },
        RegexesConfig = new [] { new RegexConfigProperty {
            Action = "action",
            Name = "name",
            Pattern = "pattern",

            // the properties below are optional
            Description = "description"
        } }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } },
    TopicPolicyConfig = new TopicPolicyConfigProperty {
        TopicsConfig = new [] { new TopicConfigProperty {
            Definition = "definition",
            Name = "name",
            Type = "type",

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

Synopsis

Properties

BlockedInputMessaging

The message to return when the guardrail blocks a prompt.
BlockedOutputsMessaging

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

The content filter policies to configure for the guardrail.
ContextualGroundingPolicyConfig

Contextual grounding policy config for a guardrail.
Description

A description of the guardrail.
KmsKeyArn

The ARN of the AWS KMS key that you use to encrypt the guardrail.
Name

The name of the guardrail.
SensitiveInformationPolicyConfig

The sensitive information policy to configure for the guardrail.
Tags

The tags that you want to attach to the guardrail.
TopicPolicyConfig

The topic policies to configure for the guardrail.
WordPolicyConfig

The word policy you configure for the guardrail.

Properties

BlockedInputMessaging

The message to return when the guardrail blocks a prompt.

string BlockedInputMessaging { get; }
Property Value

System.String

Remarks

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

BlockedOutputsMessaging

The message to return when the guardrail blocks a model response.

string BlockedOutputsMessaging { get; }
Property Value

System.String

Remarks

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

ContentPolicyConfig

The content filter policies to configure for the guardrail.

virtual object ContentPolicyConfig { get; }
Property Value

System.Object

Remarks

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

ContextualGroundingPolicyConfig

Contextual grounding policy config for a guardrail.

virtual object ContextualGroundingPolicyConfig { get; }
Property Value

System.Object

Remarks

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

Description

A description of the guardrail.

virtual string Description { get; }
Property Value

System.String

Remarks

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

KmsKeyArn

The ARN of the AWS KMS key that you use to encrypt the guardrail.

virtual string KmsKeyArn { get; }
Property Value

System.String

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn

Name

The name of the guardrail.

string Name { get; }
Property Value

System.String

Remarks

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

SensitiveInformationPolicyConfig

The sensitive information policy to configure for the guardrail.

virtual object SensitiveInformationPolicyConfig { get; }
Property Value

System.Object

Remarks

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

Tags

The tags that you want to attach to the guardrail.

virtual ICfnTag[] Tags { get; }
Property Value

ICfnTag[]

Remarks

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

TopicPolicyConfig

The topic policies to configure for the guardrail.

virtual object TopicPolicyConfig { get; }
Property Value

System.Object

Remarks

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

WordPolicyConfig

The word policy you configure for the guardrail.

virtual object WordPolicyConfig { get; }
Property Value

System.Object

Remarks

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