AWS::Wisdom::KnowledgeBase
Specifies a knowledge base.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Wisdom::KnowledgeBase", "Properties" : { "Description" :String, "KnowledgeBaseType" :String, "Name" :String, "RenderingConfiguration" :RenderingConfiguration, "ServerSideEncryptionConfiguration" :ServerSideEncryptionConfiguration, "SourceConfiguration" :SourceConfiguration, "Tags" :[ Tag, ... ], "VectorIngestionConfiguration" :VectorIngestionConfiguration} }
YAML
Type: AWS::Wisdom::KnowledgeBase Properties: Description:StringKnowledgeBaseType:StringName:StringRenderingConfiguration:RenderingConfigurationServerSideEncryptionConfiguration:ServerSideEncryptionConfigurationSourceConfiguration:SourceConfigurationTags:- TagVectorIngestionConfiguration:VectorIngestionConfiguration
Properties
Description-
The description.
Required: No
Type: String
Minimum:
1Maximum:
255Update requires: Replacement
KnowledgeBaseType-
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.
Required: Yes
Type: String
Allowed values:
EXTERNAL | CUSTOM | MESSAGE_TEMPLATES | MANAGEDUpdate requires: Replacement
Name-
The name of the knowledge base.
Required: Yes
Type: String
Minimum:
1Maximum:
255Update requires: Replacement
RenderingConfiguration-
Information about how to render the content.
Required: No
Type: RenderingConfiguration
Update requires: No interruption
ServerSideEncryptionConfiguration-
This customer managed key must have a policy that allows
kms:CreateGrantandkms:DescribeKeypermissions 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.Required: No
Type: ServerSideEncryptionConfiguration
Update requires: Replacement
SourceConfiguration-
The source of the knowledge base content. Only set this argument for EXTERNAL or Managed knowledge bases.
Required: No
Type: SourceConfiguration
Update requires: Replacement
-
The tags used to organize, track, or control access for this resource.
Required: No
Type: Array of Tag
Update requires: Replacement
VectorIngestionConfiguration-
Contains details about how to ingest the documents in a data source.
Required: No
Type: VectorIngestionConfiguration
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the knowledge base ID.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
KnowledgeBaseArn-
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseId-
The ID of the knowledge base.
