Package software.amazon.awscdk.services.bedrock

Interface CfnGuardrail.RegexConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardrail.RegexConfigProperty.Jsii$Proxy

Enclosing class:

CfnGuardrail

@Stability(Stable)
public static interface CfnGuardrail.RegexConfigProperty
extends software.amazon.jsii.JsiiSerializable

The regular expression 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.services.bedrock.*;
 RegexConfigProperty regexConfigProperty = RegexConfigProperty.builder()
         .action("action")
         .name("name")
         .pattern("pattern")
         // the properties below are optional
         .description("description")
         .inputAction("inputAction")
         .inputEnabled(false)
         .outputAction("outputAction")
         .outputEnabled(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGuardrail.RegexConfigProperty.Builder	builder()
String	getAction()	The guardrail action to configure when matching regular expression is detected.
default String	getDescription()	The description of the regular expression to configure for the guardrail.
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 input.
String	getName()	The name of the regular expression to configure for the guardrail.
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.
String	getPattern()	The regular expression pattern to configure for the guardrail.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAction

@Stability(Stable)
@NotNull
String getAction()

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

getName

@Stability(Stable)
@NotNull
String getName()

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

getPattern

@Stability(Stable)
@NotNull
String getPattern()

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

getDescription

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

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

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

getInputEnabled

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

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

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

See Also:

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

builder

@Stability(Stable)
static CfnGuardrail.RegexConfigProperty.Builder builder()

Returns:

a CfnGuardrail.RegexConfigProperty.Builder of CfnGuardrail.RegexConfigProperty