This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::QuickSight::KnowledgeBase
Creates a knowledge base from a specified data source. Supported data source connector types include:
-
S3_KNOWLEDGE_BASE– Uses an Amazon S3 bucket as the data source. -
WEB_CRAWLER– Uses web pages indexed by the built-in web crawler as the data source. -
GOOGLE_DRIVE– Uses Google Drive as the data source. Supports service account authentication only. -
SHAREPOINT– Uses SharePoint as the data source. Supports two-legged OAuth only. -
ONE_DRIVE– Uses OneDrive as the data source. Supports two-legged OAuth only.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::QuickSight::KnowledgeBase", "Properties" : { "AccessControlConfiguration" :AccessControlConfiguration, "AwsAccountId" :String, "DataSourceArn" :String, "Description" :String, "IsEmailNotificationOptedForIngestionFailures" :Boolean, "KnowledgeBaseConfiguration" :KnowledgeBaseConfiguration, "KnowledgeBaseId" :String, "MediaExtractionConfiguration" :MediaExtractionConfiguration, "Name" :String, "Permissions" :[ ResourcePermission, ... ], "PrimaryOwnerArn" :String, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::QuickSight::KnowledgeBase Properties: AccessControlConfiguration:AccessControlConfigurationAwsAccountId:StringDataSourceArn:StringDescription:StringIsEmailNotificationOptedForIngestionFailures:BooleanKnowledgeBaseConfiguration:KnowledgeBaseConfigurationKnowledgeBaseId:StringMediaExtractionConfiguration:MediaExtractionConfigurationName:StringPermissions:- ResourcePermissionPrimaryOwnerArn:StringTags:- Tag
Properties
AccessControlConfiguration-
The access control configuration for the knowledge base.
Required: No
Type: AccessControlConfiguration
Update requires: No interruption
AwsAccountId-
The ID of the AWS account that contains the knowledge base.
Required: Yes
Type: String
Pattern:
^[0-9]*$Minimum:
12Maximum:
12Update requires: Replacement
DataSourceArn-
The ARN of the data source associated with the knowledge base.
Required: Yes
Type: String
Pattern:
^arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}$Minimum:
0Maximum:
1284Update requires: Replacement
Description-
The description of the knowledge base.
Required: No
Type: String
Pattern:
^\P{C}*$Maximum:
1000Update requires: No interruption
IsEmailNotificationOptedForIngestionFailures-
Specifies whether email notifications are enabled for ingestion failures.
Required: No
Type: Boolean
Update requires: No interruption
KnowledgeBaseConfiguration-
The configuration settings for the knowledge base.
Required: Yes
Type: KnowledgeBaseConfiguration
Update requires: No interruption
KnowledgeBaseId-
The unique identifier for the knowledge base.
Required: Yes
Type: String
Pattern:
^[0-9a-zA-Z-_=.+]+$Minimum:
1Maximum:
1024Update requires: Replacement
MediaExtractionConfiguration-
The media extraction configuration for the knowledge base.
Required: No
Type: MediaExtractionConfiguration
Update requires: No interruption
Name-
The name of the knowledge base.
Required: Yes
Type: String
Pattern:
^[\p{L}\p{N}][\p{L}\p{N} _\-\.]*$Maximum:
128Update requires: No interruption
Permissions-
A list of resource permissions on the knowledge base. Each entry grants a specified Amazon QuickSight principal either owner or viewer access. If you don't specify permissions, only the primary owner (if provided) receives owner access.
Required: No
Type: Array of ResourcePermission
Minimum:
1Maximum:
64Update requires: No interruption
PrimaryOwnerArn-
The ARN of the primary owner of the knowledge base.
Required: No
Type: String
Update requires: Replacement
-
The tags to assign to the knowledge base. If you don't specify tags, the knowledge base is created without tags.
Required: No
Type: Array of Tag
Minimum:
1Maximum:
200Update requires: No interruption
Return values
Ref
Fn::GetAtt
CreatedAt-
The date and time that the knowledge base was created.
DocumentCount-
The number of documents in the knowledge base.
KnowledgeBaseArn-
The Amazon Resource Name (ARN) of the knowledge base.
KnowledgeBaseSizeBytes-
The size of the knowledge base in bytes.
PrimaryOwnerUsername-
The username of the primary owner of the knowledge base.
Status-
The status of the knowledge base.
Type-
The type of the knowledge base.
UpdatedAt-
The date and time that the knowledge base was last updated.
