Skip to content
v2.275.0

WordConfigProperty Struct ​

A word to configure for the guardrail.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrock as bedrock } from 'aws-cdk-lib';
const wordConfigProperty: bedrock.CfnGuardrail.WordConfigProperty = {
  text: 'text',

  // the properties below are optional
  inputAction: 'inputAction',
  inputEnabled: false,
  outputAction: 'outputAction',
  outputEnabled: false,
};

Properties ​

inputActionoptionalstringinput_actionoptionalstrinputActionoptionalStringInputActionoptionalstringInputActionoptional*string#
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.
inputEnabledoptionalboolean | IResolvableinput_enabledoptionaltyping.Union[bool, IResolvable]inputEnabledoptionalBooleanInputEnabledoptionalboolInputEnabledoptionalinterface{}#
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.

outputActionoptionalstringoutput_actionoptionalstroutputActionoptionalStringOutputActionoptionalstringOutputActionoptional*string#
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.
outputEnabledoptionalboolean | IResolvableoutput_enabledoptionaltyping.Union[bool, IResolvable]outputEnabledoptionalBooleanOutputEnabledoptionalboolOutputEnabledoptionalinterface{}#
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.

textstringtextstrtextStringTextstringText*stringrequired#
Text of the word configured for the guardrail to block.