Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Interface CfnGuardrailPropsMixin.WordConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardrailPropsMixin.WordConfigProperty.Jsii$Proxy

Enclosing class:

CfnGuardrailPropsMixin

@Stability(Stable)
public static interface CfnGuardrailPropsMixin.WordConfigProperty
extends software.amazon.jsii.JsiiSerializable

A word to configure for the guardrail.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 WordConfigProperty wordConfigProperty = WordConfigProperty.builder()
         .inputAction("inputAction")
         .inputEnabled(false)
         .outputAction("outputAction")
         .outputEnabled(false)
         .text("text")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-wordconfig.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnGuardrailPropsMixin.WordConfigProperty.Builder	A builder for CfnGuardrailPropsMixin.WordConfigProperty
static final class	CfnGuardrailPropsMixin.WordConfigProperty.Jsii$Proxy	An implementation for CfnGuardrailPropsMixin.WordConfigProperty

Method Summary

Modifier and Type	Method	Description
static CfnGuardrailPropsMixin.WordConfigProperty.Builder	builder()
default String	getInputAction()	Specifies the action to take when harmful content is detected in the input.
default Object	getInputEnabled()	Specifies whether to enable guardrail evaluation on the intput.
default String	getOutputAction()	Specifies the action to take when harmful content is detected in the output.
default Object	getOutputEnabled()	Specifies whether to enable guardrail evaluation on the output.
default String	getText()	Text of the word configured for the guardrail to block.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getInputAction

@Stability(Stable)
@Nullable
default String getInputAction()

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

• BLOCK – Block the content and replace it with blocked messaging.
• NONE – Take no action but return detection information in the trace response.

See Also:

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

getInputEnabled

@Stability(Stable)
@Nullable
default Object getInputEnabled()

Specifies whether to enable guardrail evaluation on the intput.

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

Returns union: either Boolean or IResolvable

See Also:

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

getOutputAction

@Stability(Stable)
@Nullable
default String getOutputAction()

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

• BLOCK – Block the content and replace it with blocked messaging.
• NONE – Take no action but return detection information in the trace response.

See Also:

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

getOutputEnabled

@Stability(Stable)
@Nullable
default Object getOutputEnabled()

Specifies whether to enable guardrail evaluation on the output.

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

Returns union: either Boolean or IResolvable

See Also:

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

getText

@Stability(Stable)
@Nullable
default String getText()

Text of the word configured for the guardrail to block.

See Also:

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

builder

@Stability(Stable)
static CfnGuardrailPropsMixin.WordConfigProperty.Builder builder()

Returns:

a CfnGuardrailPropsMixin.WordConfigProperty.Builder of CfnGuardrailPropsMixin.WordConfigProperty