interface CfnKnowledgeBaseMixinProps

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.Wisdom.Mixins.CfnKnowledgeBaseMixinProps
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awswisdom/mixins#CfnKnowledgeBaseMixinProps
Java	software.amazon.awscdk.mixins.preview.services.wisdom.mixins.CfnKnowledgeBaseMixinProps
Python	aws_cdk.mixins_preview.aws_wisdom.mixins.CfnKnowledgeBaseMixinProps
TypeScript	@aws-cdk/mixins-preview » aws_wisdom » mixins » CfnKnowledgeBaseMixinProps

Properties for CfnKnowledgeBasePropsMixin.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as wisdom_mixins } from '@aws-cdk/mixins-preview/aws-wisdom';
const cfnKnowledgeBaseMixinProps: wisdom_mixins.CfnKnowledgeBaseMixinProps = {
  description: 'description',
  knowledgeBaseType: 'knowledgeBaseType',
  name: 'name',
  renderingConfiguration: {
    templateUri: 'templateUri',
  },
  serverSideEncryptionConfiguration: {
    kmsKeyId: 'kmsKeyId',
  },
  sourceConfiguration: {
    appIntegrations: {
      appIntegrationArn: 'appIntegrationArn',
      objectFields: ['objectFields'],
    },
    managedSourceConfiguration: {
      webCrawlerConfiguration: {
        crawlerLimits: {
          rateLimit: 123,
        },
        exclusionFilters: ['exclusionFilters'],
        inclusionFilters: ['inclusionFilters'],
        scope: 'scope',
        urlConfiguration: {
          seedUrls: [{
            url: 'url',
          }],
        },
      },
    },
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  vectorIngestionConfiguration: {
    chunkingConfiguration: {
      chunkingStrategy: 'chunkingStrategy',
      fixedSizeChunkingConfiguration: {
        maxTokens: 123,
        overlapPercentage: 123,
      },
      hierarchicalChunkingConfiguration: {
        levelConfigurations: [{
          maxTokens: 123,
        }],
        overlapTokens: 123,
      },
      semanticChunkingConfiguration: {
        breakpointPercentileThreshold: 123,
        bufferSize: 123,
        maxTokens: 123,
      },
    },
    parsingConfiguration: {
      bedrockFoundationModelConfiguration: {
        modelArn: 'modelArn',
        parsingPrompt: {
          parsingPromptText: 'parsingPromptText',
        },
      },
      parsingStrategy: 'parsingStrategy',
    },
  },
};

Properties

Name	Type	Description
description?	string	The description.
knowledgeBaseType?	string	The type of knowledge base.
name?	string	The name of the knowledge base.
renderingConfiguration?	IResolvable | RenderingConfigurationProperty	Information about how to render the content.
serverSideEncryptionConfiguration?	IResolvable | ServerSideEncryptionConfigurationProperty	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.
sourceConfiguration?	IResolvable | SourceConfigurationProperty	The source of the knowledge base content.
tags?	CfnTag[]	The tags used to organize, track, or control access for this resource.
vectorIngestionConfiguration?	IResolvable | VectorIngestionConfigurationProperty	Contains details about how to ingest the documents in a data source.

---

description?

Type: string (optional)

The description.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-description

---

knowledgeBaseType?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-knowledgebasetype

---

name?

Type: string (optional)

The name of the knowledge base.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-name

---

renderingConfiguration?

Type: IResolvable | RenderingConfigurationProperty (optional)

Information about how to render the content.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-renderingconfiguration

---

serverSideEncryptionConfiguration?

Type: IResolvable | ServerSideEncryptionConfigurationProperty (optional)

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 Amazon Connect Wisdom for your instance . For information about valid ID values, see Key identifiers (KeyId) in the AWS Key Management Service Developer Guide .

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-serversideencryptionconfiguration

---

sourceConfiguration?

Type: IResolvable | SourceConfigurationProperty (optional)

The source of the knowledge base content.

Only set this argument for EXTERNAL or Managed knowledge bases.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-sourceconfiguration

---

tags?

Type: CfnTag[] (optional)

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-tags

---

vectorIngestionConfiguration?

Type: IResolvable | VectorIngestionConfigurationProperty (optional)

Contains details about how to ingest the documents in a data source.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wisdom-knowledgebase.html#cfn-wisdom-knowledgebase-vectoringestionconfiguration