# CfnKnowledgeBaseProps

Properties for defining a `CfnKnowledgeBase`.

Extends: CfnKnowledgeBaseProps
Used as props by: CfnKnowledgeBase

- Source: Generated code
- Type last changed: v2.172.0 · 7 Dec 2024

## Example

```ts
// 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'],
    },
    managedSourceConfiguration: {
      webCrawlerConfiguration: {
        urlConfiguration: {
          seedUrls: [{
            url: 'url',
          }],
        },

        // the properties below are optional
        crawlerLimits: {
          rateLimit: 123,
        },
        exclusionFilters: ['exclusionFilters'],
        inclusionFilters: ['inclusionFilters'],
        scope: 'scope',
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vectorIngestionConfiguration: {
    chunkingConfiguration: {
      chunkingStrategy: 'chunkingStrategy',

      // the properties below are optional
      fixedSizeChunkingConfiguration: {
        maxTokens: 123,
        overlapPercentage: 123,
      },
      hierarchicalChunkingConfiguration: {
        levelConfigurations: [{
          maxTokens: 123,
        }],
        overlapTokens: 123,
      },
      semanticChunkingConfiguration: {
        breakpointPercentileThreshold: 123,
        bufferSize: 123,
        maxTokens: 123,
      },
    },
    parsingConfiguration: {
      parsingStrategy: 'parsingStrategy',

      // the properties below are optional
      bedrockFoundationModelConfiguration: {
        modelArn: 'modelArn',

        // the properties below are optional
        parsingPrompt: {
          parsingPromptText: 'parsingPromptText',
        },
      },
    },
  },
};
```

## Properties

- `description`: string — The description.

- `knowledgeBaseType`: string (required) — 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`: string (required) — The name of the knowledge base.

- `renderingConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnKnowledgeBase.RenderingConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_wisdom.CfnKnowledgeBase.RenderingConfigurationProperty.html) — Information about how to render the content.

- `serverSideEncryptionConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_wisdom.CfnKnowledgeBase.ServerSideEncryptionConfigurationProperty.html) — This customer managed key must have a policy that allows `kms:CreateGrant` and `kms:DescribeKey` permissions to the IAM identity using the key to invoke Wisdom.

  For more information about setting up a customer managed key for Wisdom, see [Enable Connect Customer Wisdom for your instance](https://docs.aws.amazon.com/connect/latest/adminguide/enable-wisdom.html) . For information about valid ID values, see [Key identifiers (KeyId)](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id) in the *AWS Key Management Service Developer Guide* .

- `sourceConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnKnowledgeBase.SourceConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_wisdom.CfnKnowledgeBase.SourceConfigurationProperty.html) — The source of the knowledge base content.

  Only set this argument for EXTERNAL or Managed knowledge bases.

- `tags`: [CfnTag](/cdk/api/v2/docs/aws-cdk-lib.CfnTag.html)[] — The tags used to organize, track, or control access for this resource.

- `vectorIngestionConfiguration`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnKnowledgeBase.VectorIngestionConfigurationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_wisdom.CfnKnowledgeBase.VectorIngestionConfigurationProperty.html) — Contains details about how to ingest the documents in a data source.