Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnGuardrailMixinProps.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnGuardrailMixinProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardrailMixinProps>

Enclosing interface:

CfnGuardrailMixinProps

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

A builder for CfnGuardrailMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnGuardrailMixinProps.Builder	automatedReasoningPolicyConfig(CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty automatedReasoningPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getAutomatedReasoningPolicyConfig()
CfnGuardrailMixinProps.Builder	automatedReasoningPolicyConfig(IResolvable automatedReasoningPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getAutomatedReasoningPolicyConfig()
CfnGuardrailMixinProps.Builder	blockedInputMessaging(String blockedInputMessaging)	Sets the value of CfnGuardrailMixinProps.getBlockedInputMessaging()
CfnGuardrailMixinProps.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	Sets the value of CfnGuardrailMixinProps.getBlockedOutputsMessaging()
CfnGuardrailMixinProps	build()	Builds the configured instance.
CfnGuardrailMixinProps.Builder	contentPolicyConfig(CfnGuardrailPropsMixin.ContentPolicyConfigProperty contentPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getContentPolicyConfig()
CfnGuardrailMixinProps.Builder	contentPolicyConfig(IResolvable contentPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getContentPolicyConfig()
CfnGuardrailMixinProps.Builder	contextualGroundingPolicyConfig(CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getContextualGroundingPolicyConfig()
CfnGuardrailMixinProps.Builder	contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getContextualGroundingPolicyConfig()
CfnGuardrailMixinProps.Builder	crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty crossRegionConfig)	Sets the value of CfnGuardrailMixinProps.getCrossRegionConfig()
CfnGuardrailMixinProps.Builder	crossRegionConfig(IResolvable crossRegionConfig)	Sets the value of CfnGuardrailMixinProps.getCrossRegionConfig()
CfnGuardrailMixinProps.Builder	description(String description)	Sets the value of CfnGuardrailMixinProps.getDescription()
CfnGuardrailMixinProps.Builder	kmsKeyArn(String kmsKeyArn)	Sets the value of CfnGuardrailMixinProps.getKmsKeyArn()
CfnGuardrailMixinProps.Builder	name(String name)	Sets the value of CfnGuardrailMixinProps.getName()
CfnGuardrailMixinProps.Builder	sensitiveInformationPolicyConfig(CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getSensitiveInformationPolicyConfig()
CfnGuardrailMixinProps.Builder	sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getSensitiveInformationPolicyConfig()
CfnGuardrailMixinProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnGuardrailMixinProps.getTags()
CfnGuardrailMixinProps.Builder	topicPolicyConfig(CfnGuardrailPropsMixin.TopicPolicyConfigProperty topicPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getTopicPolicyConfig()
CfnGuardrailMixinProps.Builder	topicPolicyConfig(IResolvable topicPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getTopicPolicyConfig()
CfnGuardrailMixinProps.Builder	wordPolicyConfig(CfnGuardrailPropsMixin.WordPolicyConfigProperty wordPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getWordPolicyConfig()
CfnGuardrailMixinProps.Builder	wordPolicyConfig(IResolvable wordPolicyConfig)	Sets the value of CfnGuardrailMixinProps.getWordPolicyConfig()

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

automatedReasoningPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder automatedReasoningPolicyConfig(IResolvable automatedReasoningPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getAutomatedReasoningPolicyConfig()

Parameters:

automatedReasoningPolicyConfig - Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

Returns:

this

automatedReasoningPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder automatedReasoningPolicyConfig(CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty automatedReasoningPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getAutomatedReasoningPolicyConfig()

Parameters:

automatedReasoningPolicyConfig - Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.

Returns:

this

blockedInputMessaging

@Stability(Stable)
public CfnGuardrailMixinProps.Builder blockedInputMessaging(String blockedInputMessaging)

Sets the value of CfnGuardrailMixinProps.getBlockedInputMessaging()

Parameters:

blockedInputMessaging - The message to return when the guardrail blocks a prompt.

Returns:

this

blockedOutputsMessaging

@Stability(Stable)
public CfnGuardrailMixinProps.Builder blockedOutputsMessaging(String blockedOutputsMessaging)

Sets the value of CfnGuardrailMixinProps.getBlockedOutputsMessaging()

Parameters:

blockedOutputsMessaging - The message to return when the guardrail blocks a model response.

Returns:

this

contentPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder contentPolicyConfig(IResolvable contentPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - The content filter policies to configure for the guardrail.

Returns:

this

contentPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder contentPolicyConfig(CfnGuardrailPropsMixin.ContentPolicyConfigProperty contentPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - The content filter policies to configure for the guardrail.

Returns:

this

contextualGroundingPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getContextualGroundingPolicyConfig()

Parameters:

contextualGroundingPolicyConfig - Contextual grounding policy config for a guardrail.

Returns:

this

contextualGroundingPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder contextualGroundingPolicyConfig(CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getContextualGroundingPolicyConfig()

Parameters:

contextualGroundingPolicyConfig - Contextual grounding policy config for a guardrail.

Returns:

this

crossRegionConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder crossRegionConfig(IResolvable crossRegionConfig)

Sets the value of CfnGuardrailMixinProps.getCrossRegionConfig()

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.

For more information, see the Amazon Bedrock User Guide .

Returns:

this

crossRegionConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty crossRegionConfig)

Sets the value of CfnGuardrailMixinProps.getCrossRegionConfig()

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. Guardrail profiles define the destination AWS Regions where guardrail inference requests can be automatically routed. Using guardrail profiles helps maintain guardrail performance and reliability when demand increases.

For more information, see the Amazon Bedrock User Guide .

Returns:

this

description

@Stability(Stable)
public CfnGuardrailMixinProps.Builder description(String description)

Sets the value of CfnGuardrailMixinProps.getDescription()

Parameters:

description - A description of the guardrail.

Returns:

this

kmsKeyArn

@Stability(Stable)
public CfnGuardrailMixinProps.Builder kmsKeyArn(String kmsKeyArn)

Sets the value of CfnGuardrailMixinProps.getKmsKeyArn()

Parameters:

kmsKeyArn - The ARN of the AWS key that you use to encrypt the guardrail.

Returns:

this

name

@Stability(Stable)
public CfnGuardrailMixinProps.Builder name(String name)

Sets the value of CfnGuardrailMixinProps.getName()

Parameters:

name - The name of the guardrail.

Returns:

this

sensitiveInformationPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getSensitiveInformationPolicyConfig()

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail.

Returns:

this

sensitiveInformationPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder sensitiveInformationPolicyConfig(CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getSensitiveInformationPolicyConfig()

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail.

Returns:

this

tags

@Stability(Stable)
public CfnGuardrailMixinProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnGuardrailMixinProps.getTags()

Parameters:

tags - The tags that you want to attach to the guardrail.

Returns:

this

topicPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder topicPolicyConfig(IResolvable topicPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getTopicPolicyConfig()

Parameters:

topicPolicyConfig - The topic policies to configure for the guardrail.

Returns:

this

topicPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder topicPolicyConfig(CfnGuardrailPropsMixin.TopicPolicyConfigProperty topicPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getTopicPolicyConfig()

Parameters:

topicPolicyConfig - The topic policies to configure for the guardrail.

Returns:

this

wordPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder wordPolicyConfig(IResolvable wordPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getWordPolicyConfig()

Parameters:

wordPolicyConfig - The word policy you configure for the guardrail.

Returns:

this

wordPolicyConfig

@Stability(Stable)
public CfnGuardrailMixinProps.Builder wordPolicyConfig(CfnGuardrailPropsMixin.WordPolicyConfigProperty wordPolicyConfig)

Sets the value of CfnGuardrailMixinProps.getWordPolicyConfig()

Parameters:

wordPolicyConfig - The word policy you configure for the guardrail.

Returns:

this

build

@Stability(Stable)
public CfnGuardrailMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnGuardrailMixinProps

Throws:

NullPointerException - if any required attribute was not provided