View a markdown version of this page

AWS::QuickSight::KnowledgeBase AccessControlConfiguration - AWS CloudFormation

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 AccessControlConfiguration

The access control settings for a knowledge base. Use this structure to enable or disable document-level access control lists (ACLs) that filter query results based on the permissions from the source data connector.

Syntax

To declare this entity in your CloudFormation template, use the following syntax:

JSON

{ "IsACLEnabled" : Boolean }

YAML

IsACLEnabled: Boolean

Properties

IsACLEnabled

Specifies whether ACLs are enabled for the knowledge base.

This setting works together with the data source connector's ACL crawling. To enforce document-level access control end to end, set isACLEnabled to true and enable ACL crawling on the connector. For example, for an Amazon S3 data source, set accessControlConfiguration.crawlAcl to true in the connector template. For more information, see KbTemplateConfiguration. Enabling only one of the two settings does not produce a fully ACL-enforced knowledge base.

Required: No

Type: Boolean

Update requires: No interruption