All Superinterfaces:: software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:: CfnAIAgentMixinProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-04-02T21:55:35.022Z") @Stability(Stable) public interface CfnAIAgentMixinProps extends software.amazon.jsii.JsiiSerializable

Properties for CfnAIAgentPropsMixin.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.wisdom.*;
 Object annotations;
 Object inputSchema;
 Object outputSchema;
 CfnAIAgentMixinProps cfnAIAgentMixinProps = CfnAIAgentMixinProps.builder()
         .assistantId("assistantId")
         .configuration(AIAgentConfigurationProperty.builder()
                 .answerRecommendationAiAgentConfiguration(AnswerRecommendationAIAgentConfigurationProperty.builder()
                         .answerGenerationAiGuardrailId("answerGenerationAiGuardrailId")
                         .answerGenerationAiPromptId("answerGenerationAiPromptId")
                         .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                                 .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                         .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                                 .contentTagFilter(TagFilterProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .intentLabelingGenerationAiPromptId("intentLabelingGenerationAiPromptId")
                         .locale("locale")
                         .queryReformulationAiPromptId("queryReformulationAiPromptId")
                         .build())
                 .caseSummarizationAiAgentConfiguration(CaseSummarizationAIAgentConfigurationProperty.builder()
                         .caseSummarizationAiGuardrailId("caseSummarizationAiGuardrailId")
                         .caseSummarizationAiPromptId("caseSummarizationAiPromptId")
                         .locale("locale")
                         .build())
                 .emailGenerativeAnswerAiAgentConfiguration(EmailGenerativeAnswerAIAgentConfigurationProperty.builder()
                         .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                                 .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                         .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                                 .contentTagFilter(TagFilterProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .emailGenerativeAnswerAiPromptId("emailGenerativeAnswerAiPromptId")
                         .emailQueryReformulationAiPromptId("emailQueryReformulationAiPromptId")
                         .locale("locale")
                         .build())
                 .emailOverviewAiAgentConfiguration(EmailOverviewAIAgentConfigurationProperty.builder()
                         .emailOverviewAiPromptId("emailOverviewAiPromptId")
                         .locale("locale")
                         .build())
                 .emailResponseAiAgentConfiguration(EmailResponseAIAgentConfigurationProperty.builder()
                         .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                                 .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                         .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                                 .contentTagFilter(TagFilterProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .emailQueryReformulationAiPromptId("emailQueryReformulationAiPromptId")
                         .emailResponseAiPromptId("emailResponseAiPromptId")
                         .locale("locale")
                         .build())
                 .manualSearchAiAgentConfiguration(ManualSearchAIAgentConfigurationProperty.builder()
                         .answerGenerationAiGuardrailId("answerGenerationAiGuardrailId")
                         .answerGenerationAiPromptId("answerGenerationAiPromptId")
                         .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                                 .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                         .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                                 .contentTagFilter(TagFilterProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .locale("locale")
                         .build())
                 .noteTakingAiAgentConfiguration(NoteTakingAIAgentConfigurationProperty.builder()
                         .locale("locale")
                         .noteTakingAiGuardrailId("noteTakingAiGuardrailId")
                         .noteTakingAiPromptId("noteTakingAiPromptId")
                         .build())
                 .orchestrationAiAgentConfiguration(OrchestrationAIAgentConfigurationProperty.builder()
                         .connectInstanceArn("connectInstanceArn")
                         .locale("locale")
                         .orchestrationAiGuardrailId("orchestrationAiGuardrailId")
                         .orchestrationAiPromptId("orchestrationAiPromptId")
                         .toolConfigurations(List.of(ToolConfigurationProperty.builder()
                                 .annotations(annotations)
                                 .description("description")
                                 .inputSchema(inputSchema)
                                 .instruction(ToolInstructionProperty.builder()
                                         .examples(List.of("examples"))
                                         .instruction("instruction")
                                         .build())
                                 .outputFilters(List.of(ToolOutputFilterProperty.builder()
                                         .jsonPath("jsonPath")
                                         .outputConfiguration(ToolOutputConfigurationProperty.builder()
                                                 .outputVariableNameOverride("outputVariableNameOverride")
                                                 .sessionDataNamespace("sessionDataNamespace")
                                                 .build())
                                         .build()))
                                 .outputSchema(outputSchema)
                                 .overrideInputValues(List.of(ToolOverrideInputValueProperty.builder()
                                         .jsonPath("jsonPath")
                                         .value(ToolOverrideInputValueConfigurationProperty.builder()
                                                 .constant(ToolOverrideConstantInputValueProperty.builder()
                                                         .type("type")
                                                         .value("value")
                                                         .build())
                                                 .build())
                                         .build()))
                                 .title("title")
                                 .toolId("toolId")
                                 .toolName("toolName")
                                 .toolType("toolType")
                                 .userInteractionConfiguration(UserInteractionConfigurationProperty.builder()
                                         .isUserConfirmationRequired(false)
                                         .build())
                                 .build()))
                         .build())
                 .selfServiceAiAgentConfiguration(SelfServiceAIAgentConfigurationProperty.builder()
                         .associationConfigurations(List.of(AssociationConfigurationProperty.builder()
                                 .associationConfigurationData(AssociationConfigurationDataProperty.builder()
                                         .knowledgeBaseAssociationConfigurationData(KnowledgeBaseAssociationConfigurationDataProperty.builder()
                                                 .contentTagFilter(TagFilterProperty.builder()
                                                         .andConditions(List.of(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .selfServiceAiGuardrailId("selfServiceAiGuardrailId")
                         .selfServiceAnswerGenerationAiPromptId("selfServiceAnswerGenerationAiPromptId")
                         .selfServicePreProcessingAiPromptId("selfServicePreProcessingAiPromptId")
                         .build())
                 .build())
         .description("description")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .type("type")
         .build();

See Also:

Nested Class Summary

Nested Classes

Modifier and Type

Interface

Description

static final class

CfnAIAgentMixinProps.Builder

A builder for CfnAIAgentMixinProps

static final class

CfnAIAgentMixinProps.Jsii$Proxy

An implementation for CfnAIAgentMixinProps
Method Summary

Modifier and Type

Method

Description

static CfnAIAgentMixinProps.Builder

builder()

default String

getAssistantId()

The identifier of the Amazon Q in Connect assistant.

default Object

getConfiguration()

Configuration for the AI Agent.

default String

getDescription()

The description of the AI Agent.

default String

getName()

The name of the AI Agent.

default Map<String,String>

getTags()

The tags used to organize, track, or control access for this resource.

default String

getType()

The type of the AI Agent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

Method Details
- 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-aiagent.html#cfn-wisdom-aiagent-assistantid
- getConfiguration
  
  @Stability(Stable) @Nullable default Object getConfiguration()
  
  Configuration for the AI Agent.
  Returns union: either IResolvable or CfnAIAgentPropsMixin.AIAgentConfigurationProperty
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-configuration
- getDescription
  
  @Stability(Stable) @Nullable default String getDescription()
  
  The description of the AI Agent.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-description
- getName
  
  @Stability(Stable) @Nullable default String getName()
  
  The name of the AI Agent.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-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-aiagent.html#cfn-wisdom-aiagent-tags
- getType
  
  @Stability(Stable) @Nullable default String getType()
  
  The type of the AI Agent.
  See Also:
  
  http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-type
- builder
  
  @Stability(Stable) static CfnAIAgentMixinProps.Builder builder()
  
  Returns:
  
  a CfnAIAgentMixinProps.Builder of CfnAIAgentMixinProps

Interface CfnAIAgentMixinProps

Nested Class Summary

Method Summary

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Method Details

getAssistantId

getConfiguration

getDescription

getName

getTags

getType

builder