Class CfnAIPromptMixinProps

Properties for CfnAIPromptPropsMixin.

Inheritance

object

CfnAIPromptMixinProps

Implements

ICfnAIPromptMixinProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnAIPromptMixinProps : ICfnAIPromptMixinProps

Syntax (vb)

Public Class CfnAIPromptMixinProps Implements ICfnAIPromptMixinProps

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins;

             var cfnAIPromptMixinProps = new CfnAIPromptMixinProps {
                 ApiFormat = "apiFormat",
                 AssistantId = "assistantId",
                 Description = "description",
                 ModelId = "modelId",
                 Name = "name",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TemplateConfiguration = new AIPromptTemplateConfigurationProperty {
                     TextFullAiPromptEditTemplateConfiguration = new TextFullAIPromptEditTemplateConfigurationProperty {
                         Text = "text"
                     }
                 },
                 TemplateType = "templateType",
                 Type = "type"
             };

Synopsis

Constructors

CfnAIPromptMixinProps()

Properties for CfnAIPromptPropsMixin.

Properties

ApiFormat	The API format used for this AI Prompt.
AssistantId	The identifier of the Amazon Q in Connect assistant.
Description	The description of the AI Prompt.
ModelId	The identifier of the model used for this AI Prompt. The following model Ids are supported:.
Name	The name of the AI Prompt.
Tags	The tags used to organize, track, or control access for this resource.
TemplateConfiguration	The configuration of the prompt template for this AI Prompt.
TemplateType	The type of the prompt template for this AI Prompt.
Type	The type of this AI Prompt.

Constructors

CfnAIPromptMixinProps()

Properties for CfnAIPromptPropsMixin.

public CfnAIPromptMixinProps()

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins;

             var cfnAIPromptMixinProps = new CfnAIPromptMixinProps {
                 ApiFormat = "apiFormat",
                 AssistantId = "assistantId",
                 Description = "description",
                 ModelId = "modelId",
                 Name = "name",
                 Tags = new Dictionary<string, string> {
                     { "tagsKey", "tags" }
                 },
                 TemplateConfiguration = new AIPromptTemplateConfigurationProperty {
                     TextFullAiPromptEditTemplateConfiguration = new TextFullAIPromptEditTemplateConfigurationProperty {
                         Text = "text"
                     }
                 },
                 TemplateType = "templateType",
                 Type = "type"
             };

Properties

ApiFormat

The API format used for this AI Prompt.

public string? ApiFormat { get; set; }

Property Value

string

Remarks

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

AssistantId

The identifier of the Amazon Q in Connect assistant.

public string? AssistantId { get; set; }

Property Value

string

Remarks

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

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

Description

The description of the AI Prompt.

public string? Description { get; set; }

Property Value

string

Remarks

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

ModelId

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

public string? ModelId { get; set; }

Property Value

string

Remarks

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

Name

The name of the AI Prompt.

public string? Name { get; set; }

Property Value

string

Remarks

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

TemplateConfiguration

The configuration of the prompt template for this AI Prompt.

public object? TemplateConfiguration { get; set; }

Property Value

object

Remarks

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

Type union: either IResolvable or CfnAIPromptPropsMixin.IAIPromptTemplateConfigurationProperty

TemplateType

The type of the prompt template for this AI Prompt.

public string? TemplateType { get; set; }

Property Value

string

Remarks

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

Type

The type of this AI Prompt.

public string? Type { get; set; }