AWS::QuickSight::DataSet - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::QuickSight::DataSet

Creates a dataset. This operation doesn't support datasets that include uploaded files as a source.

Syntax

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

JSON

{ "Type" : "AWS::QuickSight::DataSet", "Properties" : { "AwsAccountId" : String, "ColumnGroups" : [ ColumnGroup, ... ], "ColumnLevelPermissionRules" : [ ColumnLevelPermissionRule, ... ], "DataSetId" : String, "DataSetUsageConfiguration" : DataSetUsageConfiguration, "FieldFolders" : {Key : Value, ...}, "ImportMode" : String, "IngestionWaitPolicy" : IngestionWaitPolicy, "LogicalTableMap" : {Key : Value, ...}, "Name" : String, "Permissions" : [ ResourcePermission, ... ], "PhysicalTableMap" : {Key : Value, ...}, "RowLevelPermissionDataSet" : RowLevelPermissionDataSet, "Tags" : [ Tag, ... ] } }

Properties

AwsAccountId

The Amazon account ID.

Required: No

Type: String

Minimum: 12

Maximum: 12

Pattern: ^[0-9]{12}$

Update requires: Replacement

ColumnGroups

Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.

Required: No

Type: List of ColumnGroup

Maximum: 8

Update requires: No interruption

ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule .

Required: No

Type: List of ColumnLevelPermissionRule

Update requires: No interruption

DataSetId

An ID for the dataset that you want to create. This ID is unique per Amazon Web Services Region for each Amazon account.

Required: No

Type: String

Update requires: Replacement

DataSetUsageConfiguration

The usage configuration to apply to child datasets that reference this dataset as a source.

Required: No

Type: DataSetUsageConfiguration

Update requires: No interruption

FieldFolders

The folder that contains fields and nested subfolders for your dataset.

Required: No

Type: Map of FieldFolder

Update requires: No interruption

ImportMode

Indicates whether you want to import the data into SPICE.

Required: No

Type: String

Allowed values: DIRECT_QUERY | SPICE

Update requires: No interruption

IngestionWaitPolicy

The wait policy to use when creating or updating a Dataset. The default is to wait for SPICE ingestion to finish with timeout of 36 hours.

Required: No

Type: IngestionWaitPolicy

Update requires: No interruption

LogicalTableMap

Configures the combination and transformation of the data from the physical tables.

Required: No

Type: Map of LogicalTable

Update requires: No interruption

Name

The display name for the dataset.

Required: No

Type: String

Minimum: 1

Maximum: 128

Update requires: No interruption

Permissions

A list of resource permissions on the dataset.

Required: No

Type: List of ResourcePermission

Maximum: 64

Update requires: No interruption

PhysicalTableMap

Declares the physical tables that are available in the underlying data sources.

Required: No

Type: Map of PhysicalTable

Update requires: No interruption

RowLevelPermissionDataSet

The row-level security configuration for the data that you want to create.

Required: No

Type: RowLevelPermissionDataSet

Update requires: No interruption

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Required: No

Type: List of Tag

Maximum: 200

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the dataset.

ConsumedSpiceCapacityInBytes

CreatedTime

The time this dataset version was created.

LastUpdatedTime

The time this dataset version was last updated.

OutputColumns