Package software.amazon.awscdk.services.wisdom

Interface CfnAIAgentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAIAgentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)",
           date="2026-01-23T11:19:56.537Z")
@Stability(Stable)
public interface CfnAIAgentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAIAgent.

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.*;
 Object annotations;
 Object inputSchema;
 Object outputSchema;
 CfnAIAgentProps cfnAIAgentProps = CfnAIAgentProps.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")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .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")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .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")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .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")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .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()
                         .orchestrationAiPromptId("orchestrationAiPromptId")
                         // the properties below are optional
                         .connectInstanceArn("connectInstanceArn")
                         .locale("locale")
                         .orchestrationAiGuardrailId("orchestrationAiGuardrailId")
                         .toolConfigurations(List.of(ToolConfigurationProperty.builder()
                                 .toolName("toolName")
                                 .toolType("toolType")
                                 // the properties below are optional
                                 .annotations(annotations)
                                 .description("description")
                                 .inputSchema(inputSchema)
                                 .instruction(ToolInstructionProperty.builder()
                                         .examples(List.of("examples"))
                                         .instruction("instruction")
                                         .build())
                                 .outputFilters(List.of(ToolOutputFilterProperty.builder()
                                         .jsonPath("jsonPath")
                                         // the properties below are optional
                                         .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")
                                 .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")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build()))
                                                         .orConditions(List.of(OrConditionProperty.builder()
                                                                 .andConditions(List.of(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build()))
                                                                 .tagCondition(TagConditionProperty.builder()
                                                                         .key("key")
                                                                         // the properties below are optional
                                                                         .value("value")
                                                                         .build())
                                                                 .build()))
                                                         .tagCondition(TagConditionProperty.builder()
                                                                 .key("key")
                                                                 // the properties below are optional
                                                                 .value("value")
                                                                 .build())
                                                         .build())
                                                 .maxResults(123)
                                                 .overrideKnowledgeBaseSearchType("overrideKnowledgeBaseSearchType")
                                                 .build())
                                         .build())
                                 .associationId("associationId")
                                 .associationType("associationType")
                                 .build()))
                         .selfServiceAiGuardrailId("selfServiceAiGuardrailId")
                         .selfServiceAnswerGenerationAiPromptId("selfServiceAnswerGenerationAiPromptId")
                         .selfServicePreProcessingAiPromptId("selfServicePreProcessingAiPromptId")
                         .build())
                 .build())
         .type("type")
         // the properties below are optional
         .description("description")
         .name("name")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAIAgentProps.Builder	A builder for CfnAIAgentProps
static final class	CfnAIAgentProps.Jsii$Proxy	An implementation for CfnAIAgentProps

Method Summary

Modifier and Type	Method	Description
static CfnAIAgentProps.Builder	builder()
String	getAssistantId()	The identifier of the Amazon Q in Connect assistant.
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.
String	getType()	The type of the AI Agent.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAssistantId

@Stability(Stable)
@NotNull
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)
@NotNull
Object getConfiguration()

Configuration for the AI Agent.

Returns union: either IResolvable or CfnAIAgent.AIAgentConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-aiagent.html#cfn-wisdom-aiagent-configuration

getType

@Stability(Stable)
@NotNull
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

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

builder

@Stability(Stable)
static CfnAIAgentProps.Builder builder()

Returns:

a CfnAIAgentProps.Builder of CfnAIAgentProps