interface CfnAIPromptProps

Language	Type name
.NET	Amazon.CDK.AWS.Wisdom.CfnAIPromptProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnAIPromptProps
Java	software.amazon.awscdk.services.wisdom.CfnAIPromptProps
Python	aws_cdk.aws_wisdom.CfnAIPromptProps
TypeScript	aws-cdk-lib » aws_wisdom » CfnAIPromptProps

Properties for defining a CfnAIPrompt.

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_wisdom as wisdom } from 'aws-cdk-lib';
const cfnAIPromptProps: wisdom.CfnAIPromptProps = {
  apiFormat: 'apiFormat',
  modelId: 'modelId',
  templateConfiguration: {
    textFullAiPromptEditTemplateConfiguration: {
      text: 'text',
    },
  },
  templateType: 'templateType',
  type: 'type',

  // the properties below are optional
  assistantId: 'assistantId',
  description: 'description',
  name: 'name',
  tags: {
    tagsKey: 'tags',
  },
};

Properties

Name	Type	Description
apiFormat	string	The API format used for this AI Prompt.
modelId	string	The identifier of the model used for this AI Prompt.
templateConfiguration	IResolvable | AIPromptTemplateConfigurationProperty	The configuration of the prompt template for this AI Prompt.
templateType	string	The type of the prompt template for this AI Prompt.
type	string	The type of this AI Prompt.
assistantId?	string	The identifier of the Amazon Q in Connect assistant.
description?	string	The description of the AI Prompt.
name?	string	The name of the AI Prompt.
tags?	{ [string]: string }	The tags used to organize, track, or control access for this resource.

---

apiFormat

Type: string

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

---

modelId

Type: string

The identifier of the model used for this AI Prompt.

Model Ids supported are: 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

---

templateConfiguration

Type: IResolvable | AIPromptTemplateConfigurationProperty

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

---

templateType

Type: string

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

---

type

Type: string

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

---

assistantId?

Type: string (optional)

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

---

description?

Type: string (optional)

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

---

name?

Type: string (optional)

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

---

tags?

Type: { [string]: string } (optional)

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