AWS::Bedrock::Guardrail WordConfig - AWS CloudFormation

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::Bedrock::Guardrail WordConfig

A word to configure for the guardrail.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "InputAction" : String, "InputEnabled" : Boolean, "OutputAction" : String, "OutputEnabled" : Boolean, "Text" : String }

YAML

InputAction: String InputEnabled: Boolean OutputAction: String OutputEnabled: Boolean Text: String

Properties

InputAction

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.

Required: No

Type: String

Allowed values: BLOCK | NONE

Update requires: No interruption

InputEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

OutputAction

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.

Required: No

Type: String

Allowed values: BLOCK | NONE

Update requires: No interruption

OutputEnabled

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.

Required: No

Type: Boolean

Update requires: No interruption

Text

Text of the word configured for the guardrail to block.

Required: Yes

Type: String

Minimum: 1

Update requires: No interruption