software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase

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

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.827Z")
 @Stability(value=Stable)
public class CfnKnowledgeBase
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Wisdom::KnowledgeBase`.

Specifies a knowledge base.

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.*;
 CfnKnowledgeBase cfnKnowledgeBase = CfnKnowledgeBase.Builder.create(this, "MyCfnKnowledgeBase")
         .knowledgeBaseType("knowledgeBaseType")
         .name("name")
         // the properties below are optional
         .description("description")
         .renderingConfiguration(RenderingConfigurationProperty.builder()
                 .templateUri("templateUri")
                 .build())
         .serverSideEncryptionConfiguration(ServerSideEncryptionConfigurationProperty.builder()
                 .kmsKeyId("kmsKeyId")
                 .build())
         .sourceConfiguration(SourceConfigurationProperty.builder()
                 .appIntegrations(AppIntegrationsConfigurationProperty.builder()
                         .appIntegrationArn("appIntegrationArn")
                         .objectFields(List.of("objectFields"))
                         .build())
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnKnowledgeBase.AppIntegrationsConfigurationProperty Configuration information for Amazon AppIntegrations to automatically ingest content.
static class	CfnKnowledgeBase.Builder A fluent builder for CfnKnowledgeBase.
static interface	CfnKnowledgeBase.RenderingConfigurationProperty Information about how to render the content.
static interface	CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty The KMS key used for encryption.
static interface	CfnKnowledgeBase.SourceConfigurationProperty Configuration information about the external data source.

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
	CfnKnowledgeBase(software.constructs.Construct scope, String id, CfnKnowledgeBaseProps props) Create a new `AWS::Wisdom::KnowledgeBase`.
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnKnowledgeBase(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrKnowledgeBaseArn() The Amazon Resource Name (ARN) of the knowledge base.
String	getAttrKnowledgeBaseId() The ID of the knowledge base.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description.
String	getKnowledgeBaseType() The type of knowledge base.
String	getName() The name of the knowledge base.
Object	getRenderingConfiguration() Information about how to render the content.
Object	getServerSideEncryptionConfiguration() The KMS key used for encryption.
Object	getSourceConfiguration() The source of the knowledge base content.
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	setDescription(String value) The description.
void	setKnowledgeBaseType(String value) The type of knowledge base.
void	setName(String value) The name of the knowledge base.
void	setRenderingConfiguration(CfnKnowledgeBase.RenderingConfigurationProperty value) Information about how to render the content.
void	setRenderingConfiguration(IResolvable value) Information about how to render the content.
void	setServerSideEncryptionConfiguration(CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value) The KMS key used for encryption.
void	setServerSideEncryptionConfiguration(IResolvable value) The KMS key used for encryption.
void	setSourceConfiguration(CfnKnowledgeBase.SourceConfigurationProperty value) The source of the knowledge base content.
void	setSourceConfiguration(IResolvable value) The source of the knowledge base content.

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

CfnKnowledgeBase

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

CfnKnowledgeBase

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

CfnKnowledgeBase

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

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

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.

getAttrKnowledgeBaseArn

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

The Amazon Resource Name (ARN) of the knowledge base.

getAttrKnowledgeBaseId

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

The ID of the knowledge base.

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.

getKnowledgeBaseType

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

The type of knowledge base.

Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

setKnowledgeBaseType

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

The type of knowledge base.

Only CUSTOM knowledge bases allow you to upload your own content. EXTERNAL knowledge bases support integrations with third-party systems whose content is synchronized automatically.

getName

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

The name of the knowledge base.

setName

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

The name of the knowledge base.

getDescription

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

The description.

setDescription

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

The description.

getRenderingConfiguration

@Stability(value=Stable)
 @Nullable
public Object getRenderingConfiguration()

Information about how to render the content.

setRenderingConfiguration

@Stability(value=Stable)
public void setRenderingConfiguration(@Nullable
                                                               CfnKnowledgeBase.RenderingConfigurationProperty value)

Information about how to render the content.

setRenderingConfiguration

@Stability(value=Stable)
public void setRenderingConfiguration(@Nullable
                                                               IResolvable value)

Information about how to render the content.

getServerSideEncryptionConfiguration

@Stability(value=Stable)
 @Nullable
public Object getServerSideEncryptionConfiguration()

The KMS key used for encryption.

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value)

The KMS key used for encryption.

setServerSideEncryptionConfiguration

@Stability(value=Stable)
public void setServerSideEncryptionConfiguration(@Nullable
                                                                          IResolvable value)

The KMS key used for encryption.

getSourceConfiguration

@Stability(value=Stable)
 @Nullable
public Object getSourceConfiguration()

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

setSourceConfiguration

@Stability(value=Stable)
public void setSourceConfiguration(@Nullable
                                                            CfnKnowledgeBase.SourceConfigurationProperty value)

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

setSourceConfiguration

@Stability(value=Stable)
public void setSourceConfiguration(@Nullable
                                                            IResolvable value)

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.