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 RegexConfig
The regular expression to configure for the guardrail.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Action" :
String
, "Description" :String
, "InputAction" :String
, "InputEnabled" :Boolean
, "Name" :String
, "OutputAction" :String
, "OutputEnabled" :Boolean
, "Pattern" :String
}
YAML
Action:
String
Description:String
InputAction:String
InputEnabled:Boolean
Name:String
OutputAction:String
OutputEnabled:Boolean
Pattern:String
Properties
Action
-
The guardrail action to configure when matching regular expression is detected.
Required: Yes
Type: String
Allowed values:
BLOCK | ANONYMIZE | NONE
Update requires: No interruption
Description
-
The description of the regular expression to configure for the guardrail.
Required: No
Type: String
Minimum:
1
Maximum:
1000
Update requires: No interruption
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 | ANONYMIZE | NONE
Update requires: No interruption
-
InputEnabled
-
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.
Required: No
Type: Boolean
Update requires: No interruption
Name
-
The name of the regular expression to configure for the guardrail.
Required: Yes
Type: String
Minimum:
1
Maximum:
100
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 | ANONYMIZE | 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
Pattern
-
The regular expression pattern to configure for the guardrail.
Required: Yes
Type: String
Minimum:
1
Update requires: No interruption