software.amazon.awscdk.services.wisdom

Class CfnKnowledgeBase

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.wisdom.CfnKnowledgeBase

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:40.827Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnKnowledgeBase(Construct scope, java.lang.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
java.lang.String	getAttrKnowledgeBaseArn() The Amazon Resource Name (ARN) of the knowledge base.
java.lang.String	getAttrKnowledgeBaseId() The ID of the knowledge base.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getDescription() The description.
java.lang.String	getKnowledgeBaseType() The type of knowledge base.
java.lang.String	getName() The name of the knowledge base.
java.lang.Object	getRenderingConfiguration() Information about how to render the content.
java.lang.Object	getServerSideEncryptionConfiguration() The KMS key used for encryption.
java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setDescription(java.lang.String value) The description.
void	setKnowledgeBaseType(java.lang.String value) The type of knowledge base.
void	setName(java.lang.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.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnKnowledgeBase(Construct scope,
                        java.lang.String id,
                        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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrKnowledgeBaseArn

public java.lang.String getAttrKnowledgeBaseArn()

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

getAttrKnowledgeBaseId

public java.lang.String getAttrKnowledgeBaseId()

The ID of the knowledge base.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

public TagManager getTags()

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

getKnowledgeBaseType

public java.lang.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

public void setKnowledgeBaseType(java.lang.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

public java.lang.String getName()

The name of the knowledge base.

setName

public void setName(java.lang.String value)

The name of the knowledge base.

getDescription

public java.lang.String getDescription()

The description.

setDescription

public void setDescription(java.lang.String value)

The description.

getRenderingConfiguration

public java.lang.Object getRenderingConfiguration()

Information about how to render the content.

setRenderingConfiguration

public void setRenderingConfiguration(IResolvable value)

Information about how to render the content.

setRenderingConfiguration

public void setRenderingConfiguration(CfnKnowledgeBase.RenderingConfigurationProperty value)

Information about how to render the content.

getServerSideEncryptionConfiguration

public java.lang.Object getServerSideEncryptionConfiguration()

The KMS key used for encryption.

setServerSideEncryptionConfiguration

public void setServerSideEncryptionConfiguration(IResolvable value)

The KMS key used for encryption.

setServerSideEncryptionConfiguration

public void setServerSideEncryptionConfiguration(CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty value)

The KMS key used for encryption.

getSourceConfiguration

public java.lang.Object getSourceConfiguration()

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

setSourceConfiguration

public void setSourceConfiguration(IResolvable value)

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

setSourceConfiguration

public void setSourceConfiguration(CfnKnowledgeBase.SourceConfigurationProperty value)

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.