interface CfnKnowledgeBaseProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.Wisdom.CfnKnowledgeBaseProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awswisdom#CfnKnowledgeBaseProps |
Java | software.amazon.awscdk.services.wisdom.CfnKnowledgeBaseProps |
Python | aws_cdk.aws_wisdom.CfnKnowledgeBaseProps |
TypeScript | aws-cdk-lib » aws_wisdom » CfnKnowledgeBaseProps |
Properties for defining a CfnKnowledgeBase
.
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 { 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
Name | Type | Description |
---|---|---|
knowledge | string | The type of knowledge base. |
name | string | The name of the knowledge base. |
description? | string | The description. |
rendering | IResolvable | Rendering | Information about how to render the content. |
server | IResolvable | Server | 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. |
source | IResolvable | Source | The source of the knowledge base content. |
tags? | Cfn [] | 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
|
Rendering
(optional)
Information about how to render the content.
serverSideEncryptionConfiguration?
Type:
IResolvable
|
Server
(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 .
sourceConfiguration?
Type:
IResolvable
|
Source
(optional)
The source of the knowledge base content.
Only set this argument for EXTERNAL knowledge bases.
tags?
Type:
Cfn
[]
(optional)
The tags used to organize, track, or control access for this resource.