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.104.0 (build e79254c)",
           date="2024-11-06T23:25:18.266Z")
@Stability(Stable)
public class CfnAIAgent
extends CfnResource
implements IInspectable, ITaggableV2

Definition of AWS::Wisdom::AIAgent Resource Type.

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()
                         .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")
                         .queryReformulationAiPromptId("queryReformulationAiPromptId")
                         .build())
                 .manualSearchAiAgentConfiguration(ManualSearchAIAgentConfigurationProperty.builder()
                         .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()))
                         .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	Example:
static interface	CfnAIAgent.AnswerRecommendationAIAgentConfigurationProperty	Example:
static interface	CfnAIAgent.AssociationConfigurationDataProperty	Example:
static interface	CfnAIAgent.AssociationConfigurationProperty	Example:
static final class	CfnAIAgent.Builder	A fluent builder for CfnAIAgent.
static interface	CfnAIAgent.KnowledgeBaseAssociationConfigurationDataProperty	Example:
static interface	CfnAIAgent.ManualSearchAIAgentConfigurationProperty	Example:
static interface	CfnAIAgent.OrConditionProperty	Example:
static interface	CfnAIAgent.TagConditionProperty	Example:
static interface	CfnAIAgent.TagFilterProperty	Example:

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()
String	getAttrAiAgentArn()
String	getAttrAiAgentId()
String	getAttrAssistantArn()
TagManager	getCdkTagManager()	Tag Manager which manages the tags for this resource.
protected Map<String,Object>	getCfnProperties()
Object	getConfiguration()
String	getDescription()
String	getName()
Map<String,String>	getTags()
String	getType()
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAssistantId(String value)
void	setConfiguration(IResolvable value)
void	setConfiguration(CfnAIAgent.AIAgentConfigurationProperty value)
void	setDescription(String value)
void	setName(String value)
void	setTags(Map<String,String> value)
void	setType(String value)

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()

getAttrAiAgentId

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

getAttrAssistantArn

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

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()

setAssistantId

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

getConfiguration

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

setConfiguration

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

setConfiguration

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

getType

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

setType

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

getDescription

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

setDescription

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

getName

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

setName

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

getTags

@Stability(Stable)
@Nullable
public Map<String,String> getTags()

setTags

@Stability(Stable)
public void setTags(@Nullable
 Map<String,String> value)