AWS::QuickSight::KnowledgeBase

QuickSight KnowledgeBase

Definition of AWS::QuickSight::KnowledgeBase Resource Type

Properties

12 configurable properties. 5 required. Click a row to see details.

Filter:

Property	Type	Flags
`AwsAccountId`	`string`	RequiredCreate-only
`DataSourceArn`	`string`	RequiredCreate-only
`KnowledgeBaseConfiguration`	`KnowledgeBaseConfiguration`	Required
`KnowledgeBaseId`	`string`	RequiredCreate-only
`Name`	`string`	Required
`AccessControlConfiguration`	`AccessControlConfiguration`
`Description`	`string`
`IsEmailNotificationOptedForIngestionFailures`	`boolean`
`MediaExtractionConfiguration`	`MediaExtractionConfiguration`
`Permissions`	`Array<ResourcePermission>`
`PrimaryOwnerArn`	`string`	Create-only
`Tags`	`Array<Tag>`

Return Values

Values returned after the resource is created. Access these with Fn::GetAtt.

Attribute	Type	Description
`CreatedAt`	`string`	-
`DocumentCount`	`number`	-
`KnowledgeBaseArn`	`string`	-
`KnowledgeBaseSizeBytes`	`number`	-
`PrimaryOwnerUsername`	`string`	-
`Status`	`string`	-
`Type`	`string`	-
`UpdatedAt`	`string`	-

Sample CloudFormation Template

A minimal template with required properties and common optional ones.

template.yaml

AWSTemplateFormatVersion: "2010-09-09"
Description: Sample template for AWS::QuickSight::KnowledgeBase

Resources:
  MyResource:
    Type: AWS::QuickSight::KnowledgeBase
    Properties:
      AwsAccountId: "my-awsaccountid"
      KnowledgeBaseId: "my-knowledgebaseid"
      Name: "my-name"
      DataSourceArn: "arn:aws:service:region:account:resource"
      KnowledgeBaseConfiguration: "value"
      Tags:
        - Key: Environment
          Value: Production
      Description: !Ref "AWS::StackName"

Required IAM Permissions

Permissions CloudFormation needs in your IAM role to manage this resource.

create

quicksight:CreateKnowledgeBasequicksight:DescribeDataSourcequicksight:DescribeKnowledgeBasequicksight:DescribeKnowledgeBasePermissionsquicksight:TagResourcequicksight:ListTagsForResourcequicksight:PassDataSource

read

quicksight:DescribeKnowledgeBasequicksight:DescribeKnowledgeBasePermissionsquicksight:ListTagsForResource

update

quicksight:UpdateKnowledgeBasequicksight:UpdateKnowledgeBasePermissionsquicksight:DescribeKnowledgeBasequicksight:DescribeKnowledgeBasePermissionsquicksight:TagResourcequicksight:UntagResourcequicksight:ListTagsForResourcequicksight:PassDataSource

delete

quicksight:DescribeKnowledgeBasequicksight:DeleteKnowledgeBase

list

quicksight:ListKnowledgeBases

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

ServiceQuickSight

Properties20

Required5

TaggingSupported

Primary IDAwsAccountId

Supported Operations

CreateReadUpdateDeleteList

Immutable After Creation

These properties cannot be changed after the resource is created. Updating them triggers a replacement.

AwsAccountIdDataSourceArnKnowledgeBaseIdPrimaryOwnerArn

Related Resources

External Links

AWS Documentation