interface CfnAIPromptMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins.CfnAIPromptMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswisdom/mixins#CfnAIPromptMixinProps
Java	software.amazon.awscdk.mixins.preview.services.wisdom.mixins.CfnAIPromptMixinProps
Python	aws_cdk.mixins_preview.aws_wisdom.mixins.CfnAIPromptMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_wisdom » mixins » CfnAIPromptMixinProps

Properties for CfnAIPromptPropsMixin.

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 { mixins as wisdom_mixins } from '@aws-cdk/mixins-preview/aws-wisdom';
const cfnAIPromptMixinProps: wisdom_mixins.CfnAIPromptMixinProps = {
  apiFormat: 'apiFormat',
  assistantId: 'assistantId',
  description: 'description',
  modelId: 'modelId',
  name: 'name',
  tags: {
    tagsKey: 'tags',
  },
  templateConfiguration: {
    textFullAiPromptEditTemplateConfiguration: {
      text: 'text',
    },
  },
  templateType: 'templateType',
  type: 'type',
};

Properties

Name	Type	Description
apiFormat?	string	The API format used for this AI Prompt.
assistantId?	string	The identifier of the Amazon Q in Connect assistant.
description?	string	The description of the AI Prompt.
modelId?	string	The identifier of the model used for this AI Prompt. The following model Ids are supported:.
name?	string	The name of the AI Prompt.
tags?	{ [string]: string }	The tags used to organize, track, or control access for this resource.
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.

---

apiFormat?

Type: string (optional)

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

---

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

---

modelId?

Type: string (optional)

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

---

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

---

templateConfiguration?

Type: IResolvable | AIPromptTemplateConfigurationProperty (optional)

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 (optional)

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 (optional)

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