Package software.amazon.awscdk.services.wisdom

Interface CfnAIPromptProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAIPromptProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)",
           date="2024-10-25T14:21:25.128Z")
@Stability(Stable)
public interface CfnAIPromptProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAIPrompt.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wisdom.*;
 CfnAIPromptProps cfnAIPromptProps = CfnAIPromptProps.builder()
         .apiFormat("apiFormat")
         .modelId("modelId")
         .templateConfiguration(AIPromptTemplateConfigurationProperty.builder()
                 .textFullAiPromptEditTemplateConfiguration(TextFullAIPromptEditTemplateConfigurationProperty.builder()
                         .text("text")
                         .build())
                 .build())
         .templateType("templateType")
         .type("type")
         // the properties below are optional
         .assistantId("assistantId")
         .description("description")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .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	CfnAIPromptProps.Builder	A builder for CfnAIPromptProps
static final class	CfnAIPromptProps.Jsii$Proxy	An implementation for CfnAIPromptProps

Method Summary

Modifier and Type	Method	Description
static CfnAIPromptProps.Builder	builder()
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.
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.
Object	getTemplateConfiguration()	The configuration of the prompt template for this AI Prompt.
String	getTemplateType()	The type of the prompt template for this AI Prompt.
String	getType()	The type of this AI Prompt.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getApiFormat

@Stability(Stable)
@NotNull
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

getModelId

@Stability(Stable)
@NotNull
String getModelId()

The identifier of the model used for this AI Prompt.

Model Ids supported are: CLAUDE_3_HAIKU_20240307_V1 .

See Also:

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

getTemplateConfiguration

@Stability(Stable)
@NotNull
Object getTemplateConfiguration()

The configuration 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-templateconfiguration

getTemplateType

@Stability(Stable)
@NotNull
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)
@NotNull
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

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

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

builder

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

Returns:

a CfnAIPromptProps.Builder of CfnAIPromptProps