Package software.amazon.awscdk.services.bedrock

Interface CfnGuardrail.TopicConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnGuardrail.TopicConfigProperty.Jsii$Proxy

Enclosing class:

CfnGuardrail

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

Details about topics for the guardrail to identify and deny.

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.*;
 TopicConfigProperty topicConfigProperty = TopicConfigProperty.builder()
         .definition("definition")
         .name("name")
         .type("type")
         // the properties below are optional
         .examples(List.of("examples"))
         .inputAction("inputAction")
         .inputEnabled(false)
         .outputAction("outputAction")
         .outputEnabled(false)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnGuardrail.TopicConfigProperty.Builder	builder()
String	getDefinition()	A definition of the topic to deny.
default List<String>	getExamples()	A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.
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 topic to deny.
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	getType()	Specifies to deny the topic.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDefinition

@Stability(Stable)
@NotNull
String getDefinition()

A definition of the topic to deny.

See Also:

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

getName

@Stability(Stable)
@NotNull
String getName()

The name of the topic to deny.

See Also:

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

getType

@Stability(Stable)
@NotNull
String getType()

Specifies to deny the topic.

See Also:

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

getExamples

@Stability(Stable)
@Nullable
default List<String> getExamples()

A list of prompts, each of which is an example of a prompt that can be categorized as belonging to the topic.

See Also:

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

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

builder

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

Returns:

a CfnGuardrail.TopicConfigProperty.Builder of CfnGuardrail.TopicConfigProperty