Package software.amazon.awscdk.services.bedrock

Class CfnGuardrail.Builder

java.lang.Object

software.amazon.awscdk.services.bedrock.CfnGuardrail.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnGuardrail>

Enclosing class:

CfnGuardrail

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

A fluent builder for CfnGuardrail.

Method Summary

Modifier and Type	Method	Description
CfnGuardrail.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the guardrail blocks a prompt.
CfnGuardrail.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the guardrail blocks a model response.
CfnGuardrail	build()
CfnGuardrail.Builder	contentPolicyConfig(IResolvable contentPolicyConfig)	The content filter policies to configure for the guardrail.
CfnGuardrail.Builder	contentPolicyConfig(CfnGuardrail.ContentPolicyConfigProperty contentPolicyConfig)	The content filter policies to configure for the guardrail.
CfnGuardrail.Builder	contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)	Contextual grounding policy config for a guardrail.
CfnGuardrail.Builder	contextualGroundingPolicyConfig(CfnGuardrail.ContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)	Contextual grounding policy config for a guardrail.
static CfnGuardrail.Builder	create(software.constructs.Construct scope, String id)
CfnGuardrail.Builder	description(String description)	A description of the guardrail.
CfnGuardrail.Builder	kmsKeyArn(String kmsKeyArn)	The ARN of the AWS KMS key that you use to encrypt the guardrail.
CfnGuardrail.Builder	name(String name)	The name of the guardrail.
CfnGuardrail.Builder	sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CfnGuardrail.Builder	sensitiveInformationPolicyConfig(CfnGuardrail.SensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)	The sensitive information policy to configure for the guardrail.
CfnGuardrail.Builder	tags(List<? extends CfnTag> tags)	The tags that you want to attach to the guardrail.
CfnGuardrail.Builder	topicPolicyConfig(IResolvable topicPolicyConfig)	The topic policies to configure for the guardrail.
CfnGuardrail.Builder	topicPolicyConfig(CfnGuardrail.TopicPolicyConfigProperty topicPolicyConfig)	The topic policies to configure for the guardrail.
CfnGuardrail.Builder	wordPolicyConfig(IResolvable wordPolicyConfig)	The word policy you configure for the guardrail.
CfnGuardrail.Builder	wordPolicyConfig(CfnGuardrail.WordPolicyConfigProperty 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 CfnGuardrail.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnGuardrail.Builder.

blockedInputMessaging

@Stability(Stable)
public CfnGuardrail.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 CfnGuardrail.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

name

@Stability(Stable)
public CfnGuardrail.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

contentPolicyConfig

@Stability(Stable)
public CfnGuardrail.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 CfnGuardrail.Builder contentPolicyConfig(CfnGuardrail.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 CfnGuardrail.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 CfnGuardrail.Builder contextualGroundingPolicyConfig(CfnGuardrail.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

description

@Stability(Stable)
public CfnGuardrail.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 CfnGuardrail.Builder kmsKeyArn(String kmsKeyArn)

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

Parameters:

kmsKeyArn - The ARN of the AWS KMS 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

sensitiveInformationPolicyConfig

@Stability(Stable)
public CfnGuardrail.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 CfnGuardrail.Builder sensitiveInformationPolicyConfig(CfnGuardrail.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 CfnGuardrail.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 CfnGuardrail.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 CfnGuardrail.Builder topicPolicyConfig(CfnGuardrail.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 CfnGuardrail.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 CfnGuardrail.Builder wordPolicyConfig(CfnGuardrail.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 CfnGuardrail build()

Specified by:

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

Returns:

a newly built instance of CfnGuardrail.