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

Class CfnGuardrailPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardrailPropsMixin>

Enclosing class:

CfnGuardrailPropsMixin

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

A fluent builder for CfnGuardrailPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnGuardrailPropsMixin.Builder	automatedReasoningPolicyConfig(CfnGuardrailPropsMixin.AutomatedReasoningPolicyConfigProperty automatedReasoningPolicyConfig)	Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
CfnGuardrailPropsMixin.Builder	automatedReasoningPolicyConfig(IResolvable automatedReasoningPolicyConfig)	Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails.
CfnGuardrailPropsMixin.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the guardrail blocks a prompt.
CfnGuardrailPropsMixin.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the guardrail blocks a model response.
CfnGuardrailPropsMixin	build()
CfnGuardrailPropsMixin.Builder	contentPolicyConfig(CfnGuardrailPropsMixin.ContentPolicyConfigProperty contentPolicyConfig)	The content filter policies to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	contentPolicyConfig(IResolvable contentPolicyConfig)	The content filter policies to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	contextualGroundingPolicyConfig(CfnGuardrailPropsMixin.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)	Contextual grounding policy config for a guardrail.
CfnGuardrailPropsMixin.Builder	contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)	Contextual grounding policy config for a guardrail.
static CfnGuardrailPropsMixin.Builder	create()
static CfnGuardrailPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnGuardrailPropsMixin.Builder	crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
CfnGuardrailPropsMixin.Builder	crossRegionConfig(IResolvable crossRegionConfig)	The system-defined guardrail profile that you're using with your guardrail.
CfnGuardrailPropsMixin.Builder	description(String description)	A description of the guardrail.
CfnGuardrailPropsMixin.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the AWS key that you use to encrypt the guardrail.
CfnGuardrailPropsMixin.Builder	name(String name)	The name of the guardrail.
CfnGuardrailPropsMixin.Builder	sensitiveInformationPolicyConfig(CfnGuardrailPropsMixin.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	tags(List<? extends CfnTag> tags)	The tags that you want to attach to the guardrail.
CfnGuardrailPropsMixin.Builder	topicPolicyConfig(CfnGuardrailPropsMixin.TopicPolicyConfigProperty topicPolicyConfig)	The topic policies to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	topicPolicyConfig(IResolvable topicPolicyConfig)	The topic policies to configure for the guardrail.
CfnGuardrailPropsMixin.Builder	wordPolicyConfig(CfnGuardrailPropsMixin.WordPolicyConfigProperty wordPolicyConfig)	The word policy you configure for the guardrail.
CfnGuardrailPropsMixin.Builder	wordPolicyConfig(IResolvable wordPolicyConfig)	The word policy you configure for the guardrail.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnGuardrailPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnGuardrailPropsMixin.Builder.

create

@Stability(Stable)
public static CfnGuardrailPropsMixin.Builder create()

Returns:

a new instance of CfnGuardrailPropsMixin.Builder.

automatedReasoningPolicyConfig

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

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

Parameters:

automatedReasoningPolicyConfig - Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig

automatedReasoningPolicyConfig

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

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

Parameters:

automatedReasoningPolicyConfig - Configuration settings for integrating Automated Reasoning policies with Amazon Bedrock Guardrails. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-automatedreasoningpolicyconfig

blockedInputMessaging

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

The message to return when the guardrail blocks a prompt.

Parameters:

blockedInputMessaging - The message to return when the guardrail blocks a prompt. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedinputmessaging

blockedOutputsMessaging

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

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

Parameters:

blockedOutputsMessaging - The message to return when the guardrail blocks a model response. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-blockedoutputsmessaging

contentPolicyConfig

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

The content filter policies to configure for the guardrail.

Parameters:

contentPolicyConfig - The content filter policies to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig

contentPolicyConfig

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

The content filter policies to configure for the guardrail.

Parameters:

contentPolicyConfig - The content filter policies to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contentpolicyconfig

contextualGroundingPolicyConfig

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

Contextual grounding policy config for a guardrail.

Parameters:

contextualGroundingPolicyConfig - Contextual grounding policy config for a guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig

contextualGroundingPolicyConfig

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

Contextual grounding policy config for a guardrail.

Parameters:

contextualGroundingPolicyConfig - Contextual grounding policy config for a guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-contextualgroundingpolicyconfig

crossRegionConfig

@Stability(Stable)
public CfnGuardrailPropsMixin.Builder crossRegionConfig(IResolvable 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 .

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig

crossRegionConfig

@Stability(Stable)
public CfnGuardrailPropsMixin.Builder crossRegionConfig(CfnGuardrailPropsMixin.GuardrailCrossRegionConfigProperty 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 .

Parameters:

crossRegionConfig - The system-defined guardrail profile that you're using with your guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-crossregionconfig

description

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

A description of the guardrail.

Parameters:

description - A description of the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-description

kmsKeyArn

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

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

Parameters:

kmsKeyArn - The ARN of the AWS key that you use to encrypt the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-kmskeyarn

name

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

The name of the guardrail.

Parameters:

name - The name of the guardrail. This parameter is required.

Returns:

this

See Also:

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

sensitiveInformationPolicyConfig

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

The sensitive information policy to configure for the guardrail.

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig

sensitiveInformationPolicyConfig

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

The sensitive information policy to configure for the guardrail.

Parameters:

sensitiveInformationPolicyConfig - The sensitive information policy to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-sensitiveinformationpolicyconfig

tags

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

The tags that you want to attach to the guardrail.

Parameters:

tags - The tags that you want to attach to the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-tags

topicPolicyConfig

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

The topic policies to configure for the guardrail.

Parameters:

topicPolicyConfig - The topic policies to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig

topicPolicyConfig

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

The topic policies to configure for the guardrail.

Parameters:

topicPolicyConfig - The topic policies to configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-topicpolicyconfig

wordPolicyConfig

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

The word policy you configure for the guardrail.

Parameters:

wordPolicyConfig - The word policy you configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig

wordPolicyConfig

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

The word policy you configure for the guardrail.

Parameters:

wordPolicyConfig - The word policy you configure for the guardrail. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-guardrail.html#cfn-bedrock-guardrail-wordpolicyconfig

build

@Stability(Stable)
public CfnGuardrailPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnGuardrailPropsMixin.