software.amazon.awscdk.services.wisdom

Class CfnAssistantAssociation

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

All Implemented Interfaces:

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

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:42.826Z")
 @Stability(value=Stable)
public class CfnAssistantAssociation
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Wisdom::AssistantAssociation`.

Specifies an association between an Amazon Connect Wisdom assistant and another resource. Currently, the only supported association is with a knowledge base. An assistant can have only a single association.

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.*;
 CfnAssistantAssociation cfnAssistantAssociation = CfnAssistantAssociation.Builder.create(this, "MyCfnAssistantAssociation")
         .assistantId("assistantId")
         .association(AssociationDataProperty.builder()
                 .knowledgeBaseId("knowledgeBaseId")
                 .build())
         .associationType("associationType")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnAssistantAssociation.AssociationDataProperty A union type that currently has a single argument, which is the knowledge base ID.
static class	CfnAssistantAssociation.Builder A fluent builder for CfnAssistantAssociation.

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

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAssistantAssociation(software.constructs.Construct scope, String id, CfnAssistantAssociationProps props) Create a new `AWS::Wisdom::AssistantAssociation`.
protected	CfnAssistantAssociation(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnAssistantAssociation(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAssistantId() The identifier of the Wisdom assistant.
Object	getAssociation() The identifier of the associated resource.
String	getAssociationType() The type of association.
String	getAttrAssistantArn() The Amazon Resource Name (ARN) of the Wisdom assistant.
String	getAttrAssistantAssociationArn() The Amazon Resource Name (ARN) of the assistant association.
String	getAttrAssistantAssociationId() The ID of the association.
protected Map<String,Object>	getCfnProperties()
TagManager	getTags() The tags used to organize, track, or control access for this resource.
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 Wisdom assistant.
void	setAssociation(CfnAssistantAssociation.AssociationDataProperty value) The identifier of the associated resource.
void	setAssociation(IResolvable value) The identifier of the associated resource.
void	setAssociationType(String value) The type of association.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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 Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnAssistantAssociation

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

CfnAssistantAssociation

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

CfnAssistantAssociation

@Stability(value=Stable)
public CfnAssistantAssociation(@NotNull
                                                        software.constructs.Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        CfnAssistantAssociationProps props)

Create a new `AWS::Wisdom::AssistantAssociation`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrAssistantArn

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

The Amazon Resource Name (ARN) of the Wisdom assistant.

getAttrAssistantAssociationArn

@Stability(value=Stable)
 @NotNull
public String getAttrAssistantAssociationArn()

The Amazon Resource Name (ARN) of the assistant association.

getAttrAssistantAssociationId

@Stability(value=Stable)
 @NotNull
public String getAttrAssistantAssociationId()

The ID of the association.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getAssistantId

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

The identifier of the Wisdom assistant.

setAssistantId

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

The identifier of the Wisdom assistant.

getAssociation

@Stability(value=Stable)
 @NotNull
public Object getAssociation()

The identifier of the associated resource.

setAssociation

@Stability(value=Stable)
public void setAssociation(@NotNull
                                                    CfnAssistantAssociation.AssociationDataProperty value)

The identifier of the associated resource.

setAssociation

@Stability(value=Stable)
public void setAssociation(@NotNull
                                                    IResolvable value)

The identifier of the associated resource.

getAssociationType

@Stability(value=Stable)
 @NotNull
public String getAssociationType()

The type of association.

setAssociationType

@Stability(value=Stable)
public void setAssociationType(@NotNull
                                                        String value)

The type of association.