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

Class CfnAIGuardrailMixinProps.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAIGuardrailMixinProps>

Enclosing interface:

CfnAIGuardrailMixinProps

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

A builder for CfnAIGuardrailMixinProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnAIGuardrailMixinProps.Builder	assistantId(String assistantId)	Sets the value of CfnAIGuardrailMixinProps.getAssistantId()
CfnAIGuardrailMixinProps.Builder	blockedInputMessaging(String blockedInputMessaging)	Sets the value of CfnAIGuardrailMixinProps.getBlockedInputMessaging()
CfnAIGuardrailMixinProps.Builder	blockedOutputsMessaging(String blockedOutputsMessaging)	Sets the value of CfnAIGuardrailMixinProps.getBlockedOutputsMessaging()
CfnAIGuardrailMixinProps	build()	Builds the configured instance.
CfnAIGuardrailMixinProps.Builder	contentPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContentPolicyConfigProperty contentPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getContentPolicyConfig()
CfnAIGuardrailMixinProps.Builder	contentPolicyConfig(IResolvable contentPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getContentPolicyConfig()
CfnAIGuardrailMixinProps.Builder	contextualGroundingPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getContextualGroundingPolicyConfig()
CfnAIGuardrailMixinProps.Builder	contextualGroundingPolicyConfig(IResolvable contextualGroundingPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getContextualGroundingPolicyConfig()
CfnAIGuardrailMixinProps.Builder	description(String description)	Sets the value of CfnAIGuardrailMixinProps.getDescription()
CfnAIGuardrailMixinProps.Builder	name(String name)	Sets the value of CfnAIGuardrailMixinProps.getName()
CfnAIGuardrailMixinProps.Builder	sensitiveInformationPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailSensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getSensitiveInformationPolicyConfig()
CfnAIGuardrailMixinProps.Builder	sensitiveInformationPolicyConfig(IResolvable sensitiveInformationPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getSensitiveInformationPolicyConfig()
CfnAIGuardrailMixinProps.Builder	tags(Map<String,String> tags)	Sets the value of CfnAIGuardrailMixinProps.getTags()
CfnAIGuardrailMixinProps.Builder	topicPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailTopicPolicyConfigProperty topicPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getTopicPolicyConfig()
CfnAIGuardrailMixinProps.Builder	topicPolicyConfig(IResolvable topicPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getTopicPolicyConfig()
CfnAIGuardrailMixinProps.Builder	wordPolicyConfig(CfnAIGuardrailPropsMixin.AIGuardrailWordPolicyConfigProperty wordPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.getWordPolicyConfig()
CfnAIGuardrailMixinProps.Builder	wordPolicyConfig(IResolvable wordPolicyConfig)	Sets the value of CfnAIGuardrailMixinProps.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

assistantId

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

Sets the value of CfnAIGuardrailMixinProps.getAssistantId()

Parameters:

assistantId - The identifier of the Amazon Q in Connect assistant. Can be either the ID or the ARN. URLs cannot contain the ARN.

Returns:

this

blockedInputMessaging

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

Sets the value of CfnAIGuardrailMixinProps.getBlockedInputMessaging()

Parameters:

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

Returns:

this

blockedOutputsMessaging

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

Sets the value of CfnAIGuardrailMixinProps.getBlockedOutputsMessaging()

Parameters:

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

Returns:

this

contentPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content.

Returns:

this

contentPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content.

Returns:

this

contextualGroundingPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getContextualGroundingPolicyConfig()

Parameters:

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

Returns:

this

contextualGroundingPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getContextualGroundingPolicyConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnAIGuardrailMixinProps.getDescription()

Parameters:

description - A description of the AI Guardrail.

Returns:

this

name

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

Sets the value of CfnAIGuardrailMixinProps.getName()

Parameters:

name - The name of the AI Guardrail.

Returns:

this

sensitiveInformationPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getSensitiveInformationPolicyConfig()

Parameters:

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

Returns:

this

sensitiveInformationPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getSensitiveInformationPolicyConfig()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnAIGuardrailMixinProps.getTags()

Parameters:

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

Returns:

this

topicPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getTopicPolicyConfig()

Parameters:

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

Returns:

this

topicPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getTopicPolicyConfig()

Parameters:

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

Returns:

this

wordPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getWordPolicyConfig()

Parameters:

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

Returns:

this

wordPolicyConfig

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

Sets the value of CfnAIGuardrailMixinProps.getWordPolicyConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnAIGuardrailMixinProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAIGuardrailMixinProps

Throws:

NullPointerException - if any required attribute was not provided