aws-cdk-lib.aws_wisdom.CfnKnowledgeBaseProps

interface CfnKnowledgeBaseProps

LanguageType name
.NETAmazon.CDK.AWS.Wisdom.CfnKnowledgeBaseProps
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnKnowledgeBaseProps
Javasoftware.amazon.awscdk.services.wisdom.CfnKnowledgeBaseProps
Pythonaws_cdk.aws_wisdom.CfnKnowledgeBaseProps
TypeScript aws-cdk-lib » 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 { aws_wisdom as wisdom } from 'aws-cdk-lib';
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

NameTypeDescription
knowledgeBaseTypestringThe type of knowledge base.
namestringThe name of the knowledge base.
description?stringThe description.
renderingConfiguration?IResolvable | RenderingConfigurationPropertyInformation about how to render the content.
serverSideEncryptionConfiguration?IResolvable | ServerSideEncryptionConfigurationPropertyThe KMS key used for encryption.
sourceConfiguration?IResolvable | SourceConfigurationPropertyThe 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.