AWS CDK

2.239.0

interface RegexConfigProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Bedrock.CfnGuardrail.RegexConfigProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrock#CfnGuardrail_RegexConfigProperty`
Java	`software.amazon.awscdk.services.bedrock.CfnGuardrail.RegexConfigProperty`
Python	`aws_cdk.aws_bedrock.CfnGuardrail.RegexConfigProperty`
TypeScript	`aws-cdk-lib` » `aws_bedrock` » `CfnGuardrail` » `RegexConfigProperty`

The regular expression to configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html

Example

// 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 regexConfigProperty: bedrock.CfnGuardrail.RegexConfigProperty = {
  action: 'action',
  name: 'name',
  pattern: 'pattern',

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

Properties

Name	Type	Description
action	`string`	The guardrail action to configure when matching regular expression is detected.
name	`string`	The name of the regular expression to configure for the guardrail.
pattern	`string`	The regular expression pattern to configure for the guardrail.
description?	`string`	The description of the regular expression to configure for the guardrail.
inputAction?	`string`	Specifies the action to take when harmful content is detected in the input. Supported values include:.
inputEnabled?	`boolean \|` `IResolvable`	Specifies whether to enable guardrail evaluation on the input.
outputAction?	`string`	Specifies the action to take when harmful content is detected in the output. Supported values include:.
outputEnabled?	`boolean \|` `IResolvable`	Specifies whether to enable guardrail evaluation on the output.

action

Type: string

The guardrail action to configure when matching regular expression is detected.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-action

name

Type: string

The name of the regular expression to configure for the guardrail.

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

pattern

Type: string

The regular expression pattern to configure for the guardrail.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-guardrail-regexconfig.html#cfn-bedrock-guardrail-regexconfig-pattern

description?

Type: string (optional)

The description of the regular expression to configure for the guardrail.

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

inputAction?

Type: string (optional)

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-regexconfig.html#cfn-bedrock-guardrail-regexconfig-inputaction

inputEnabled?

Type: boolean | IResolvable (optional)

Specifies whether to enable guardrail evaluation on the input.

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

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

outputAction?

Type: string (optional)

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-regexconfig.html#cfn-bedrock-guardrail-regexconfig-outputaction

outputEnabled?

Type: boolean | IResolvable (optional)

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.

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

← Previous Next →