Interface CfnGuardrail.IWordConfigProperty

A word to configure for the guardrail.

Namespace: Amazon.CDK.AWS.Bedrock

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnGuardrail.IWordConfigProperty

Syntax (vb)

Public Interface CfnGuardrail.IWordConfigProperty

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.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 wordConfigProperty = new WordConfigProperty {
                 Text = "text",

                 // the properties below are optional
                 InputAction = "inputAction",
                 InputEnabled = false,
                 OutputAction = "outputAction",
                 OutputEnabled = false
             };

Synopsis

Properties

InputAction	Specifies the action to take when harmful content is detected in the input. Supported values include:.
InputEnabled	Specifies whether to enable guardrail evaluation on the intput.
OutputAction	Specifies the action to take when harmful content is detected in the output. Supported values include:.
OutputEnabled	Specifies whether to enable guardrail evaluation on the output.
Text	Text of the word configured for the guardrail to block.

Properties

InputAction

Specifies the action to take when harmful content is detected in the input. Supported values include:.

string? InputAction { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputaction

InputEnabled

Specifies whether to enable guardrail evaluation on the intput.

object? InputEnabled { get; }

Property Value

object

Remarks

When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-inputenabled

Type union: either bool or IResolvable

OutputAction

Specifies the action to take when harmful content is detected in the output. Supported values include:.

string? OutputAction { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputaction

OutputEnabled

Specifies whether to enable guardrail evaluation on the output.

object? OutputEnabled { get; }

Property Value

object

Remarks

When disabled, you aren't charged for the evaluation. The evaluation doesn't appear in the response.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-outputenabled

Type union: either bool or IResolvable

Text

Text of the word configured for the guardrail to block.

string Text { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html#cfn-bedrock-guardrail-wordconfig-text