Package software.amazon.awscdk.services.wisdom

Class CfnAIPrompt

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.wisdom.CfnAIPrompt
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IAIPromptRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:47.466Z") @Stability(Stable) public class CfnAIPrompt extends CfnResource implements IInspectable, IAIPromptRef, ITaggableV2
Creates an Amazon Q in Connect AI Prompt.

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.*;
 CfnAIPrompt cfnAIPrompt = CfnAIPrompt.Builder.create(this, "MyCfnAIPrompt")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAIPrompt

      protected CfnAIPrompt(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAIPrompt

      protected CfnAIPrompt(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAIPrompt

      @Stability(Stable) public CfnAIPrompt(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAIPromptProps props)
      Create a new AWS::Wisdom::AIPrompt.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForAIPrompt

      @Stability(Stable) @NotNull public static String arnForAIPrompt(@NotNull IAIPromptRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnAIPrompt

      @Stability(Stable) @NotNull public static Boolean isCfnAIPrompt(@NotNull Object x)
      Checks whether the given object is a CfnAIPrompt.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAiPromptRef

      @Stability(Stable) @NotNull public AIPromptReference getAiPromptRef()
      A reference to a AIPrompt resource.
      Specified by:
      getAiPromptRef in interface IAIPromptRef

    • getAttrAiPromptArn

      @Stability(Stable) @NotNull public String getAttrAiPromptArn()
      The Amazon Resource Name (ARN) of the AI Prompt.

    • getAttrAiPromptId

      @Stability(Stable) @NotNull public String getAttrAiPromptId()
      The identifier of the Amazon Q in Connect AI prompt.

    • getAttrAssistantArn

      @Stability(Stable) @NotNull public String getAttrAssistantArn()
      The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.

    • getAttrModifiedTimeSeconds

      @Stability(Stable) @NotNull public IResolvable getAttrModifiedTimeSeconds()

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getApiFormat

      @Stability(Stable) @NotNull public String getApiFormat()
      The API format used for this AI Prompt.

    • setApiFormat

      @Stability(Stable) public void setApiFormat(@NotNull String value)
      The API format used for this AI Prompt.

    • getModelId

      @Stability(Stable) @NotNull public String getModelId()
      The identifier of the model used for this AI Prompt.

      The following model Ids are supported:.

    • setModelId

      @Stability(Stable) public void setModelId(@NotNull String value)
      The identifier of the model used for this AI Prompt.

      The following model Ids are supported:.

    • getTemplateConfiguration

      @Stability(Stable) @NotNull public Object getTemplateConfiguration()
      The configuration of the prompt template for this AI Prompt.

      Returns union: either IResolvable or CfnAIPrompt.AIPromptTemplateConfigurationProperty

    • setTemplateConfiguration

      @Stability(Stable) public void setTemplateConfiguration(@NotNull IResolvable value)
      The configuration of the prompt template for this AI Prompt.

    • setTemplateConfiguration

      @Stability(Stable) public void setTemplateConfiguration(@NotNull CfnAIPrompt.AIPromptTemplateConfigurationProperty value)
      The configuration of the prompt template for this AI Prompt.

    • getTemplateType

      @Stability(Stable) @NotNull public String getTemplateType()
      The type of the prompt template for this AI Prompt.

    • setTemplateType

      @Stability(Stable) public void setTemplateType(@NotNull String value)
      The type of the prompt template for this AI Prompt.

    • getType

      @Stability(Stable) @NotNull public String getType()
      The type of this AI Prompt.

    • setType

      @Stability(Stable) public void setType(@NotNull String value)
      The type of this AI Prompt.

    • getAssistantId

      @Stability(Stable) @Nullable public String getAssistantId()
      The identifier of the Amazon Q in Connect assistant.

    • setAssistantId

      @Stability(Stable) public void setAssistantId(@Nullable String value)
      The identifier of the Amazon Q in Connect assistant.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The description of the AI Prompt.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The description of the AI Prompt.

    • getName

      @Stability(Stable) @Nullable public String getName()
      The name of the AI Prompt.

    • setName

      @Stability(Stable) public void setName(@Nullable String value)
      The name of the AI Prompt.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags used to organize, track, or control access for this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags used to organize, track, or control access for this resource.