Package software.amazon.awscdk.cfnpropertymixins.services.wisdom

Class CfnAIGuardrailPropsMixin.Builder

java.lang.Object

software.amazon.awscdk.cfnpropertymixins.services.wisdom.CfnAIGuardrailPropsMixin.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAIGuardrailPropsMixin>

Enclosing class:

CfnAIGuardrailPropsMixin

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

A fluent builder for CfnAIGuardrailPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAIGuardrailPropsMixin.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
CfnAIGuardrailPropsMixin.Builder	blockedInputMessaging(String blockedInputMessaging)	The message to return when the AI Guardrail blocks a prompt.
CfnAIGuardrailPropsMixin.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	The message to return when the AI Guardrail blocks a model response.
CfnAIGuardrailPropsMixin	build()
CfnAIGuardrailPropsMixin.Builder	contentPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty contentPolicyConfig)	Contains details about how to handle harmful content.
CfnAIGuardrailPropsMixin.Builder	contentPolicyConfig(IResolvable contentPolicyConfig)	Contains details about how to handle harmful content.
CfnAIGuardrailPropsMixin.Builder	contextualGroundingPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)	The policy configuration details for the AI Guardrail's contextual grounding policy.
CfnAIGuardrailPropsMixin.Builder	contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)	The policy configuration details for the AI Guardrail's contextual grounding policy.
static CfnAIGuardrailPropsMixin.Builder	create()
static CfnAIGuardrailPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAIGuardrailPropsMixin.Builder	description(String description)	A description of the AI Guardrail.
CfnAIGuardrailPropsMixin.Builder	name(String name)	The name of the AI Guardrail.
CfnAIGuardrailPropsMixin.Builder	sensitiveInformationPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)	Contains details about PII entities and regular expressions to configure for the AI Guardrail.
CfnAIGuardrailPropsMixin.Builder	sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)	Contains details about PII entities and regular expressions to configure for the AI Guardrail.
CfnAIGuardrailPropsMixin.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
CfnAIGuardrailPropsMixin.Builder	topicPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty topicPolicyConfig)	Contains details about topics that the AI Guardrail should identify and deny.
CfnAIGuardrailPropsMixin.Builder	topicPolicyConfig(IResolvable topicPolicyConfig)	Contains details about topics that the AI Guardrail should identify and deny.
CfnAIGuardrailPropsMixin.Builder	wordPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty wordPolicyConfig)	Contains details about the word policy to configured for the AI Guardrail.
CfnAIGuardrailPropsMixin.Builder	wordPolicyConfig(IResolvable wordPolicyConfig)	Contains details about the word policy to configured for the AI 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 CfnAIGuardrailPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAIGuardrailPropsMixin.Builder.

create

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

Returns:

a new instance of CfnAIGuardrailPropsMixin.Builder.

assistantId

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder assistantId(String assistantId)

The identifier of the Amazon Q in Connect assistant.

Can be either the ID or the ARN. URLs cannot contain the ARN.

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant. This parameter is required.

Returns:

this

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiguardrail.html#cfn-wisdom-aiguardrail-assistantid

blockedInputMessaging

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

The message to return when the AI Guardrail blocks a prompt.

Parameters:

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

Returns:

this

See Also:

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

blockedOutputsMessaging

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

The message to return when the AI Guardrail blocks a model response.

Parameters:

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

Returns:

this

See Also:

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

contentPolicyConfig

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

Contains details about how to handle harmful content.

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content. This parameter is required.

Returns:

this

See Also:

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

contentPolicyConfig

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder contentPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty contentPolicyConfig)

Contains details about how to handle harmful content.

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content. This parameter is required.

Returns:

this

See Also:

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

contextualGroundingPolicyConfig

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

The policy configuration details for the AI Guardrail's contextual grounding policy.

Parameters:

contextualGroundingPolicyConfig - The policy configuration details for the AI Guardrail's contextual grounding policy. This parameter is required.

Returns:

this

See Also:

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

contextualGroundingPolicyConfig

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder contextualGroundingPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)

The policy configuration details for the AI Guardrail's contextual grounding policy.

Parameters:

contextualGroundingPolicyConfig - The policy configuration details for the AI Guardrail's contextual grounding policy. This parameter is required.

Returns:

this

See Also:

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

description

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

A description of the AI Guardrail.

Parameters:

description - A description of the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

name

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

The name of the AI Guardrail.

Parameters:

name - The name of the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

sensitiveInformationPolicyConfig

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

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Parameters:

sensitiveInformationPolicyConfig - Contains details about PII entities and regular expressions to configure for the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

sensitiveInformationPolicyConfig

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder sensitiveInformationPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)

Contains details about PII entities and regular expressions to configure for the AI Guardrail.

Parameters:

sensitiveInformationPolicyConfig - Contains details about PII entities and regular expressions to configure for the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder tags(Map<String,String> tags)

The tags used to organize, track, or control access for this resource.

Parameters:

tags - The tags used to organize, track, or control access for this resource. This parameter is required.

Returns:

this

See Also:

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

topicPolicyConfig

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

Contains details about topics that the AI Guardrail should identify and deny.

Parameters:

topicPolicyConfig - Contains details about topics that the AI Guardrail should identify and deny. This parameter is required.

Returns:

this

See Also:

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

topicPolicyConfig

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder topicPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty topicPolicyConfig)

Contains details about topics that the AI Guardrail should identify and deny.

Parameters:

topicPolicyConfig - Contains details about topics that the AI Guardrail should identify and deny. This parameter is required.

Returns:

this

See Also:

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

wordPolicyConfig

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

Contains details about the word policy to configured for the AI Guardrail.

Parameters:

wordPolicyConfig - Contains details about the word policy to configured for the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

wordPolicyConfig

@Stability(Stable)
public CfnAIGuardrailPropsMixin.Builder wordPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty wordPolicyConfig)

Contains details about the word policy to configured for the AI Guardrail.

Parameters:

wordPolicyConfig - Contains details about the word policy to configured for the AI Guardrail. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAIGuardrailPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAIGuardrailPropsMixin.