Package software.amazon.awscdk.services.bedrock.alpha

Class GuardrailProps.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.alpha.GuardrailProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GuardrailProps>

Enclosing interface:

GuardrailProps

@Stability(Experimental)
public static final class GuardrailProps.Builder
extends Object
implements software.amazon.jsii.Builder<GuardrailProps>

A builder for GuardrailProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GuardrailProps.Builder	blockedInputMessaging(String blockedInputMessaging)	Sets the value of GuardrailProps.getBlockedInputMessaging()
GuardrailProps.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	Sets the value of GuardrailProps.getBlockedOutputsMessaging()
GuardrailProps	build()	Builds the configured instance.
GuardrailProps.Builder	contentFilters(List<? extends ContentFilter> contentFilters)	Sets the value of GuardrailProps.getContentFilters()
GuardrailProps.Builder	contentFiltersTierConfig(TierConfig contentFiltersTierConfig)	Sets the value of GuardrailProps.getContentFiltersTierConfig()
GuardrailProps.Builder	contextualGroundingFilters(List<? extends ContextualGroundingFilter> contextualGroundingFilters)	Sets the value of GuardrailProps.getContextualGroundingFilters()
GuardrailProps.Builder	crossRegionConfig(GuardrailCrossRegionConfigProperty crossRegionConfig)	Sets the value of GuardrailProps.getCrossRegionConfig()
GuardrailProps.Builder	deniedTopics(List<? extends Topic> deniedTopics)	Sets the value of GuardrailProps.getDeniedTopics()
GuardrailProps.Builder	description(String description)	Sets the value of GuardrailProps.getDescription()
GuardrailProps.Builder	guardrailName(String guardrailName)	Sets the value of GuardrailProps.getGuardrailName()
GuardrailProps.Builder	kmsKey(IKey kmsKey)	Sets the value of GuardrailProps.getKmsKey()
GuardrailProps.Builder	managedWordListFilters(List<? extends ManagedWordFilter> managedWordListFilters)	Sets the value of GuardrailProps.getManagedWordListFilters()
GuardrailProps.Builder	piiFilters(List<? extends PIIFilter> piiFilters)	Sets the value of GuardrailProps.getPiiFilters()
GuardrailProps.Builder	regexFilters(List<? extends RegexFilter> regexFilters)	Sets the value of GuardrailProps.getRegexFilters()
GuardrailProps.Builder	topicsTierConfig(TierConfig topicsTierConfig)	Sets the value of GuardrailProps.getTopicsTierConfig()
GuardrailProps.Builder	wordFilters(List<? extends WordFilter> wordFilters)	Sets the value of GuardrailProps.getWordFilters()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

guardrailName

@Stability(Experimental)
public GuardrailProps.Builder guardrailName(String guardrailName)

Sets the value of GuardrailProps.getGuardrailName()

Parameters:

guardrailName - The name of the guardrail. This parameter is required. This will be used as the physical name of the guardrail.

Returns:

this

blockedInputMessaging

@Stability(Experimental)
public GuardrailProps.Builder blockedInputMessaging(String blockedInputMessaging)

Sets the value of GuardrailProps.getBlockedInputMessaging()

Parameters:

blockedInputMessaging - The message to return when the guardrail blocks a prompt. Must be between 1 and 500 characters.

Returns:

this

blockedOutputsMessaging

@Stability(Experimental)
public GuardrailProps.Builder blockedOutputsMessaging(String blockedOutputsMessaging)

Sets the value of GuardrailProps.getBlockedOutputsMessaging()

Parameters:

blockedOutputsMessaging - The message to return when the guardrail blocks a model response. Must be between 1 and 500 characters.

Returns:

this

contentFilters

@Stability(Experimental)
public GuardrailProps.Builder contentFilters(List<? extends ContentFilter> contentFilters)

Sets the value of GuardrailProps.getContentFilters()

Parameters:

contentFilters - The content filters to apply to the guardrail.

Returns:

this

contentFiltersTierConfig

@Stability(Experimental)
public GuardrailProps.Builder contentFiltersTierConfig(TierConfig contentFiltersTierConfig)

Sets the value of GuardrailProps.getContentFiltersTierConfig()

Parameters:

contentFiltersTierConfig - The tier configuration to apply to the guardrail.

Returns:

this

contextualGroundingFilters

@Stability(Experimental)
public GuardrailProps.Builder contextualGroundingFilters(List<? extends ContextualGroundingFilter> contextualGroundingFilters)

Sets the value of GuardrailProps.getContextualGroundingFilters()

Parameters:

contextualGroundingFilters - The contextual grounding filters to apply to the guardrail.

Returns:

this

crossRegionConfig

@Stability(Experimental)
public GuardrailProps.Builder crossRegionConfig(GuardrailCrossRegionConfigProperty crossRegionConfig)

Sets the value of GuardrailProps.getCrossRegionConfig()

Parameters:

crossRegionConfig - The cross-region configuration for the guardrail. This is optional and when provided, it should be of type GuardrailCrossRegionConfigProperty.

Returns:

this

deniedTopics

@Stability(Experimental)
public GuardrailProps.Builder deniedTopics(List<? extends Topic> deniedTopics)

Sets the value of GuardrailProps.getDeniedTopics()

Parameters:

deniedTopics - A list of policies related to topics that the guardrail should deny.

Returns:

this

description

@Stability(Experimental)
public GuardrailProps.Builder description(String description)

Sets the value of GuardrailProps.getDescription()

Parameters:

description - The description of the guardrail.

Returns:

this

kmsKey

@Stability(Experimental)
public GuardrailProps.Builder kmsKey(IKey kmsKey)

Sets the value of GuardrailProps.getKmsKey()

Parameters:

kmsKey - A custom KMS key to use for encrypting data.

Returns:

this

managedWordListFilters

@Stability(Experimental)
public GuardrailProps.Builder managedWordListFilters(List<? extends ManagedWordFilter> managedWordListFilters)

Sets the value of GuardrailProps.getManagedWordListFilters()

Parameters:

managedWordListFilters - The managed word filters to apply to the guardrail.

Returns:

this

piiFilters

@Stability(Experimental)
public GuardrailProps.Builder piiFilters(List<? extends PIIFilter> piiFilters)

Sets the value of GuardrailProps.getPiiFilters()

Parameters:

piiFilters - The PII filters to apply to the guardrail.

Returns:

this

regexFilters

@Stability(Experimental)
public GuardrailProps.Builder regexFilters(List<? extends RegexFilter> regexFilters)

Sets the value of GuardrailProps.getRegexFilters()

Parameters:

regexFilters - The regular expression (regex) filters to apply to the guardrail.

Returns:

this

topicsTierConfig

@Stability(Experimental)
public GuardrailProps.Builder topicsTierConfig(TierConfig topicsTierConfig)

Sets the value of GuardrailProps.getTopicsTierConfig()

Parameters:

topicsTierConfig - The tier configuration to apply to the guardrail.

Returns:

this

wordFilters

@Stability(Experimental)
public GuardrailProps.Builder wordFilters(List<? extends WordFilter> wordFilters)

Sets the value of GuardrailProps.getWordFilters()

Parameters:

wordFilters - The word filters to apply to the guardrail.

Returns:

this

build

@Stability(Experimental)
public GuardrailProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<GuardrailProps>

Returns:

a new instance of GuardrailProps

Throws:

NullPointerException - if any required attribute was not provided