Package software.amazon.awscdk.services.wisdom

Class CfnAIGuardrailProps.Builder

java.lang.Object

software.amazon.awscdk.services.wisdom.CfnAIGuardrailProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAIGuardrailProps>

Enclosing interface:

CfnAIGuardrailProps

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

A builder for CfnAIGuardrailProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

Sets the value of CfnAIGuardrailProps.getAssistantId()

Parameters:

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

Returns:

this

blockedInputMessaging

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

Sets the value of CfnAIGuardrailProps.getBlockedInputMessaging()

Parameters:

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

Returns:

this

blockedOutputsMessaging

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

Sets the value of CfnAIGuardrailProps.getBlockedOutputsMessaging()

Parameters:

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

Returns:

this

contentPolicyConfig

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

Sets the value of CfnAIGuardrailProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content.

Returns:

this

contentPolicyConfig

@Stability(Stable)
public CfnAIGuardrailProps.Builder contentPolicyConfig(CfnAIGuardrail.AIGuardrailContentPolicyConfigProperty contentPolicyConfig)

Sets the value of CfnAIGuardrailProps.getContentPolicyConfig()

Parameters:

contentPolicyConfig - Contains details about how to handle harmful content.

Returns:

this

contextualGroundingPolicyConfig

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

Sets the value of CfnAIGuardrailProps.getContextualGroundingPolicyConfig()

Parameters:

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

Returns:

this

contextualGroundingPolicyConfig

@Stability(Stable)
public CfnAIGuardrailProps.Builder contextualGroundingPolicyConfig(CfnAIGuardrail.AIGuardrailContextualGroundingPolicyConfigProperty contextualGroundingPolicyConfig)

Sets the value of CfnAIGuardrailProps.getContextualGroundingPolicyConfig()

Parameters:

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

Returns:

this

description

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

Sets the value of CfnAIGuardrailProps.getDescription()

Parameters:

description - A description of the AI Guardrail.

Returns:

this

name

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

Sets the value of CfnAIGuardrailProps.getName()

Parameters:

name - The name of the AI Guardrail.

Returns:

this

sensitiveInformationPolicyConfig

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

Sets the value of CfnAIGuardrailProps.getSensitiveInformationPolicyConfig()

Parameters:

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

Returns:

this

sensitiveInformationPolicyConfig

@Stability(Stable)
public CfnAIGuardrailProps.Builder sensitiveInformationPolicyConfig(CfnAIGuardrail.AIGuardrailSensitiveInformationPolicyConfigProperty sensitiveInformationPolicyConfig)

Sets the value of CfnAIGuardrailProps.getSensitiveInformationPolicyConfig()

Parameters:

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

Returns:

this

tags

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

Sets the value of CfnAIGuardrailProps.getTags()

Parameters:

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

Returns:

this

topicPolicyConfig

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

Sets the value of CfnAIGuardrailProps.getTopicPolicyConfig()

Parameters:

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

Returns:

this

topicPolicyConfig

@Stability(Stable)
public CfnAIGuardrailProps.Builder topicPolicyConfig(CfnAIGuardrail.AIGuardrailTopicPolicyConfigProperty topicPolicyConfig)

Sets the value of CfnAIGuardrailProps.getTopicPolicyConfig()

Parameters:

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

Returns:

this

wordPolicyConfig

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

Sets the value of CfnAIGuardrailProps.getWordPolicyConfig()

Parameters:

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

Returns:

this

wordPolicyConfig

@Stability(Stable)
public CfnAIGuardrailProps.Builder wordPolicyConfig(CfnAIGuardrail.AIGuardrailWordPolicyConfigProperty wordPolicyConfig)

Sets the value of CfnAIGuardrailProps.getWordPolicyConfig()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnAIGuardrailProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of CfnAIGuardrailProps

Throws:

NullPointerException - if any required attribute was not provided