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

Interface CfnAIPromptMixinProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAIPromptMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:06.275Z")
@Stability(Stable)
public interface CfnAIPromptMixinProps
extends software.amazon.jsii.JsiiSerializable

Properties for CfnAIPromptPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.wisdom.*;
 CfnAIPromptMixinProps cfnAIPromptMixinProps = CfnAIPromptMixinProps.builder()
         .apiFormat("apiFormat")
         .assistantId("assistantId")
         .description("description")
         .modelId("modelId")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .templateConfiguration(AIPromptTemplateConfigurationProperty.builder()
                 .textFullAiPromptEditTemplateConfiguration(TextFullAIPromptEditTemplateConfigurationProperty.builder()
                         .text("text")
                         .build())
                 .build())
         .templateType("templateType")
         .type("type")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAIPromptMixinProps.Builder	A builder for CfnAIPromptMixinProps
static final class	CfnAIPromptMixinProps.Jsii$Proxy	An implementation for CfnAIPromptMixinProps

Method Summary

Modifier and Type	Method	Description
static CfnAIPromptMixinProps.Builder	builder()
default String	getApiFormat()	The API format used for this AI Prompt.
default String	getAssistantId()	The identifier of the Amazon Q in Connect assistant.
default String	getDescription()	The description of the AI Prompt.
default String	getModelId()	The identifier of the model used for this AI Prompt.
default String	getName()	The name of the AI Prompt.
default Map<String,String>	getTags()	The tags used to organize, track, or control access for this resource.
default Object	getTemplateConfiguration()	The configuration of the prompt template for this AI Prompt.
default String	getTemplateType()	The type of the prompt template for this AI Prompt.
default String	getType()	The type of this AI Prompt.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiFormat

@Stability(Stable)
@Nullable
default String getApiFormat()

The API format used for this AI Prompt.

See Also:

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

getAssistantId

@Stability(Stable)
@Nullable
default String getAssistantId()

The identifier of the Amazon Q in Connect assistant.

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

See Also:

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

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the AI Prompt.

See Also:

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

getModelId

@Stability(Stable)
@Nullable
default String getModelId()

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

See Also:

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

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the AI Prompt.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

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

See Also:

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

getTemplateConfiguration

@Stability(Stable)
@Nullable
default Object getTemplateConfiguration()

The configuration of the prompt template for this AI Prompt.

Returns union: either IResolvable or CfnAIPromptPropsMixin.AIPromptTemplateConfigurationProperty

See Also:

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

getTemplateType

@Stability(Stable)
@Nullable
default String getTemplateType()

The type of the prompt template for this AI Prompt.

See Also:

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

getType

@Stability(Stable)
@Nullable
default String getType()

The type of this AI Prompt.

See Also:

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

builder

@Stability(Stable)
static CfnAIPromptMixinProps.Builder builder()

Returns:

a CfnAIPromptMixinProps.Builder of CfnAIPromptMixinProps