interface CfnKnowledgeBaseProps

Language	Type name
.NET	`Amazon.CDK.AWS.Wisdom.CfnKnowledgeBaseProps`
Java	`software.amazon.awscdk.services.wisdom.CfnKnowledgeBaseProps`
Python	`aws_cdk.aws_wisdom.CfnKnowledgeBaseProps`
TypeScript	`@aws-cdk/aws-wisdom` » `CfnKnowledgeBaseProps`

Properties for defining a CfnKnowledgeBase.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as wisdom from '@aws-cdk/aws-wisdom';
const cfnKnowledgeBaseProps: wisdom.CfnKnowledgeBaseProps = {
  knowledgeBaseType: 'knowledgeBaseType',
  name: 'name',

  // the properties below are optional
  description: 'description',
  renderingConfiguration: {
    templateUri: 'templateUri',
  },
  serverSideEncryptionConfiguration: {
    kmsKeyId: 'kmsKeyId',
  },
  sourceConfiguration: {
    appIntegrations: {
      appIntegrationArn: 'appIntegrationArn',

      // the properties below are optional
      objectFields: ['objectFields'],
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};

Properties

Name	Type	Description
knowledgeBaseType	`string`	The type of knowledge base.
name	`string`	The name of the knowledge base.
description?	`string`	The description.
renderingConfiguration?	`IResolvable` `\|` `RenderingConfigurationProperty`	Information about how to render the content.
serverSideEncryptionConfiguration?	`IResolvable` `\|` `ServerSideEncryptionConfigurationProperty`	The KMS key used for encryption.
sourceConfiguration?	`IResolvable` `\|` `SourceConfigurationProperty`	The source of the knowledge base content.
tags?	`CfnTag[]`	The tags used to organize, track, or control access for this resource.

knowledgeBaseType

Type: string

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.

name

Type: string

The name of the knowledge base.

description?

Type: string (optional)

The description.

renderingConfiguration?

Type: IResolvable | RenderingConfigurationProperty (optional)

Information about how to render the content.

serverSideEncryptionConfiguration?

Type: IResolvable | ServerSideEncryptionConfigurationProperty (optional)

The KMS key used for encryption.

sourceConfiguration?

Type: IResolvable | SourceConfigurationProperty (optional)

The source of the knowledge base content.

Only set this argument for EXTERNAL knowledge bases.

tags?

Type: CfnTag[] (optional)

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