Package software.amazon.awscdk.services.wisdom

Class CfnAIAgent

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.CfnAIAgent

All Implemented Interfaces:

IInspectable, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.106.0 (build e852934)",
           date="2025-02-26T00:07:48.173Z")
@Stability(Stable)
public class CfnAIAgent
extends CfnResource
implements IInspectable, ITaggableV2

Creates an Amazon Q in Connect AI Agent.

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.*;
 CfnAIAgent cfnAIAgent = CfnAIAgent.Builder.create(this, "MyCfnAIAgent")
         .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())
                 .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())
                 .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())
                 .sessionSummarizationAiAgentConfiguration(SessionSummarizationAIAgentConfigurationProperty.builder()
                         .locale("locale")
                         .sessionSummarizationAiPromptId("sessionSummarizationAiPromptId")
                         .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	Class	Description
static interface	CfnAIAgent.AIAgentConfigurationProperty	A typed union that specifies the configuration based on the type of AI Agent.
static interface	CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty	The configuration for AI Agents of type ANSWER_RECOMMENDATION .
static interface	CfnAIAgent.AssociationConfigurationDataProperty	A typed union of the data of the configuration for an Amazon Q in Connect Assistant Association.
static interface	CfnAIAgent.AssociationConfigurationProperty	The configuration for an Amazon Q in Connect Assistant Association.
static final class	CfnAIAgent.Builder	A fluent builder for CfnAIAgent.
static interface	CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty	The data of the configuration for a KNOWLEDGE_BASE type Amazon Q in Connect Assistant Association.
static interface	CfnAIAgent.ManualSearchAIAgentConfigurationProperty	The configuration for AI Agents of type MANUAL_SEARCH .
static interface	CfnAIAgent.OrConditionProperty	Example:
static interface	CfnAIAgent.SelfServiceAIAgentConfigurationProperty	The configuration of the self-service AI agent.
static interface	CfnAIAgent.SessionSummarizationAIAgentConfigurationProperty	Example:
static interface	CfnAIAgent.TagConditionProperty	An object that can be used to specify tag conditions.
static interface	CfnAIAgent.TagFilterProperty	An object that can be used to specify tag conditions.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2

ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnAIAgent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAIAgent(software.amazon.jsii.JsiiObjectRef objRef)
	CfnAIAgent(software.constructs.Construct scope, String id, CfnAIAgentProps props)

Method Summary

Modifier and Type	Method	Description
String	getAssistantId()	The identifier of the Amazon Q in Connect assistant.
String	getAttrAiAgentArn()	The Amazon Resource Name (ARN) of the AI agent.
String	getAttrAiAgentId()	The identifier of the AI Agent.
String	getAttrAssistantArn()	The Amazon Resource Name (ARN) of the Amazon Q in Connect assistant.
IResolvable	getAttrModifiedTimeSeconds()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()	Configuration for the AI Agent.
String	getDescription()	The description of the AI Agent.
String	getName()	The name of the AI Agent.
Map<String,String>	getTags()	The tags used to organize, track, or control access for this resource.
String	getType()	The type of the AI Agent.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssistantId(String value)	The identifier of the Amazon Q in Connect assistant.
void	setConfiguration(IResolvable value)	Configuration for the AI Agent.
void	setConfiguration(CfnAIAgent.AIAgentConfigurationProperty value)	Configuration for the AI Agent.
void	setDescription(String value)	The description of the AI Agent.
void	setName(String value)	The name of the AI Agent.
void	setTags(Map<String,String> value)	The tags used to organize, track, or control access for this resource.
void	setType(String value)	The type of the AI Agent.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

CfnAIAgent

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

CfnAIAgent

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

CfnAIAgent

@Stability(Stable)
public CfnAIAgent(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnAIAgentProps props)

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

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.

getAttrAiAgentArn

@Stability(Stable)
@NotNull
public String getAttrAiAgentArn()

The Amazon Resource Name (ARN) of the AI agent.

getAttrAiAgentId

@Stability(Stable)
@NotNull
public String getAttrAiAgentId()

The identifier of the AI Agent.

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

getAssistantId

@Stability(Stable)
@NotNull
public String getAssistantId()

The identifier of the Amazon Q in Connect assistant.

setAssistantId

@Stability(Stable)
public void setAssistantId(@NotNull
 String value)

The identifier of the Amazon Q in Connect assistant.

getConfiguration

@Stability(Stable)
@NotNull
public Object getConfiguration()

Configuration for the AI Agent.

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 IResolvable value)

Configuration for the AI Agent.

setConfiguration

@Stability(Stable)
public void setConfiguration(@NotNull
 CfnAIAgent.AIAgentConfigurationProperty value)

Configuration for the AI Agent.

getType

@Stability(Stable)
@NotNull
public String getType()

The type of the AI Agent.

setType

@Stability(Stable)
public void setType(@NotNull
 String value)

The type of the AI Agent.

getDescription

@Stability(Stable)
@Nullable
public String getDescription()

The description of the AI Agent.

setDescription

@Stability(Stable)
public void setDescription(@Nullable
 String value)

The description of the AI Agent.

getName

@Stability(Stable)
@Nullable
public String getName()

The name of the AI Agent.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The name of the AI Agent.

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.