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, ... ]
    }
}

YAML

Type: AWS::Wisdom::KnowledgeBase
Properties: 
  Description: String
  KnowledgeBaseType: String
  Name: String
  RenderingConfiguration: 
    RenderingConfiguration
  ServerSideEncryptionConfiguration: 
    ServerSideEncryptionConfiguration
  SourceConfiguration: 
    SourceConfiguration
  Tags: 
    - Tag

Properties

Description

The description.

Required: No

Type: String

Minimum: 1

Maximum: 255

Pattern: ^[a-zA-Z0-9\s_.,-]+

Update 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: CUSTOM | EXTERNAL

Update requires: Replacement

Name

The name of the knowledge base.

Required: Yes

Type: String

Minimum: 1

Maximum: 255

Pattern: ^[a-zA-Z0-9\s_.,-]+

Update requires: Replacement

RenderingConfiguration

Information about how to render the content.

Required: No

Type: RenderingConfiguration

Update requires: No interruption

ServerSideEncryptionConfiguration

The KMS key used for encryption.

Required: No

Type: ServerSideEncryptionConfiguration

Update requires: Replacement

SourceConfiguration

The source of the knowledge base content. Only set this argument for EXTERNAL knowledge bases.

Required: No

Type: SourceConfiguration

Update requires: Replacement

Tags

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

Required: No

Type: List of Tag

Update requires: Replacement

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.