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

Class CfnAIPromptPropsMixin.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnAIPromptPropsMixin>

Enclosing class:

CfnAIPromptPropsMixin

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

A fluent builder for CfnAIPromptPropsMixin.

Method Summary

Modifier and Type	Method	Description
CfnAIPromptPropsMixin.Builder	apiFormat(String apiFormat)	The API format used for this AI Prompt.
CfnAIPromptPropsMixin.Builder	assistantId(String assistantId)	The identifier of the Amazon Q in Connect assistant.
CfnAIPromptPropsMixin	build()
static CfnAIPromptPropsMixin.Builder	create()
static CfnAIPromptPropsMixin.Builder	create(CfnPropertyMixinOptions options)
CfnAIPromptPropsMixin.Builder	description(String description)	The description of the AI Prompt.
CfnAIPromptPropsMixin.Builder	modelId(String modelId)	The identifier of the model used for this AI Prompt.
CfnAIPromptPropsMixin.Builder	name(String name)	The name of the AI Prompt.
CfnAIPromptPropsMixin.Builder	tags(Map<String,String> tags)	The tags used to organize, track, or control access for this resource.
CfnAIPromptPropsMixin.Builder	templateConfiguration(CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty templateConfiguration)	The configuration of the prompt template for this AI Prompt.
CfnAIPromptPropsMixin.Builder	templateConfiguration(IResolvable templateConfiguration)	The configuration of the prompt template for this AI Prompt.
CfnAIPromptPropsMixin.Builder	templateType(String templateType)	The type of the prompt template for this AI Prompt.
CfnAIPromptPropsMixin.Builder	type(String type)	The type of this AI Prompt.

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 CfnAIPromptPropsMixin.Builder create(CfnPropertyMixinOptions options)

Parameters:

options - Mixin options.

Returns:

a new instance of CfnAIPromptPropsMixin.Builder.

create

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

Returns:

a new instance of CfnAIPromptPropsMixin.Builder.

apiFormat

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder apiFormat(String apiFormat)

The API format used for this AI Prompt.

Parameters:

apiFormat - The API format used for this AI Prompt. This parameter is required.

Returns:

this

See Also:

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

assistantId

@Stability(Stable)
public CfnAIPromptPropsMixin.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-aiprompt.html#cfn-wisdom-aiprompt-assistantid

description

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

The description of the AI Prompt.

Parameters:

description - The description of the AI Prompt. This parameter is required.

Returns:

this

See Also:

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

modelId

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder modelId(String modelId)

The identifier of the model used for this AI Prompt. The following model Ids are supported:.

• anthropic.claude-3-haiku--v1:0
• apac.amazon.nova-lite-v1:0
• apac.amazon.nova-micro-v1:0
• apac.amazon.nova-pro-v1:0
• apac.anthropic.claude-3-5-sonnet--v2:0
• apac.anthropic.claude-3-haiku-20240307-v1:0
• eu.amazon.nova-lite-v1:0
• eu.amazon.nova-micro-v1:0
• eu.amazon.nova-pro-v1:0
• eu.anthropic.claude-3-7-sonnet-20250219-v1:0
• eu.anthropic.claude-3-haiku-20240307-v1:0
• us.amazon.nova-lite-v1:0
• us.amazon.nova-micro-v1:0
• us.amazon.nova-pro-v1:0
• us.anthropic.claude-3-5-haiku-20241022-v1:0
• us.anthropic.claude-3-7-sonnet-20250219-v1:0
• us.anthropic.claude-3-haiku-20240307-v1:0

Parameters:

modelId - The identifier of the model used for this AI Prompt. The following model Ids are supported:. This parameter is required.

Returns:

this

See Also:

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

name

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

The name of the AI Prompt.

Parameters:

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

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnAIPromptPropsMixin.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-aiprompt.html#cfn-wisdom-aiprompt-tags

templateConfiguration

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder templateConfiguration(IResolvable templateConfiguration)

The configuration of the prompt template for this AI Prompt.

Parameters:

templateConfiguration - The configuration of the prompt template for this AI Prompt. This parameter is required.

Returns:

this

See Also:

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

templateConfiguration

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder templateConfiguration(CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty templateConfiguration)

The configuration of the prompt template for this AI Prompt.

Parameters:

templateConfiguration - The configuration of the prompt template for this AI Prompt. This parameter is required.

Returns:

this

See Also:

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

templateType

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder templateType(String templateType)

The type of the prompt template for this AI Prompt.

Parameters:

templateType - The type of the prompt template for this AI Prompt. This parameter is required.

Returns:

this

See Also:

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

type

@Stability(Stable)
public CfnAIPromptPropsMixin.Builder type(String type)

The type of this AI Prompt.

Parameters:

type - The type of this AI Prompt. This parameter is required.

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnAIPromptPropsMixin build()

Specified by:

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

Returns:

a newly built instance of CfnAIPromptPropsMixin.