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 AWS CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::QuickSight::DataSet", "Properties" : { "AwsAccountId" :String, "ColumnGroups" :[ ColumnGroup, ... ], "ColumnLevelPermissionRules" :[ ColumnLevelPermissionRule, ... ], "DataSetId" :String, "DatasetParameters" :[ DatasetParameter, ... ], "DataSetRefreshProperties" :DataSetRefreshProperties, "DataSetUsageConfiguration" :DataSetUsageConfiguration, "FieldFolders" :{, "FolderArns" :Key:Value, ...}[ String, ... ], "ImportMode" :String, "IngestionWaitPolicy" :IngestionWaitPolicy, "LogicalTableMap" :{, "Name" :Key:Value, ...}String, "PerformanceConfiguration" :PerformanceConfiguration, "Permissions" :[ ResourcePermission, ... ], "PhysicalTableMap" :{, "RowLevelPermissionDataSet" :Key:Value, ...}RowLevelPermissionDataSet, "RowLevelPermissionTagConfiguration" :RowLevelPermissionTagConfiguration, "Tags" :[ Tag, ... ]} }
YAML
Type: AWS::QuickSight::DataSet Properties: AwsAccountId:StringColumnGroups:- ColumnGroupColumnLevelPermissionRules:- ColumnLevelPermissionRuleDataSetId:StringDatasetParameters:- DatasetParameterDataSetRefreshProperties:DataSetRefreshPropertiesDataSetUsageConfiguration:DataSetUsageConfigurationFieldFolders:FolderArns:Key:Value- StringImportMode:StringIngestionWaitPolicy:IngestionWaitPolicyLogicalTableMap:Name:Key:ValueStringPerformanceConfiguration:PerformanceConfigurationPermissions:- ResourcePermissionPhysicalTableMap:RowLevelPermissionDataSet:Key:ValueRowLevelPermissionDataSetRowLevelPermissionTagConfiguration:RowLevelPermissionTagConfigurationTags:- Tag
Properties
AwsAccountId-
The AWS account ID.
Required: No
Type: String
Pattern:
^[0-9]{12}$Minimum:
12Maximum:
12Update requires: Replacement
ColumnGroups-
Groupings of columns that work together in certain Amazon QuickSight features. Currently, only geospatial hierarchy is supported.
Required: No
Type: Array of ColumnGroup
Minimum:
1Maximum:
8Update requires: No interruption
ColumnLevelPermissionRules-
A set of one or more definitions of a
ColumnLevelPermissionRule.Required: No
Type: Array of ColumnLevelPermissionRule
Minimum:
1Update requires: No interruption
DataSetId-
An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.
Required: No
Type: String
Update requires: Replacement
DatasetParameters-
The parameters that are declared in a dataset.
Required: No
Type: Array of DatasetParameter
Minimum:
0Maximum:
32Update requires: No interruption
DataSetRefreshProperties-
The refresh properties of a dataset.
Required: No
Type: DataSetRefreshProperties
Update requires: No interruption
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: Object of FieldFolder
Update requires: No interruption
FolderArnsProperty description not available.
Required: No
Type: Array of String
Minimum:
0Maximum:
10Update requires: No interruption
ImportMode-
Indicates whether you want to import the data into SPICE.
Required: No
Type: String
Allowed values:
SPICE | DIRECT_QUERYUpdate 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: Object of LogicalTable
Update requires: No interruption
Name-
The display name for the dataset.
Required: No
Type: String
Minimum:
1Maximum:
128Update requires: No interruption
PerformanceConfiguration-
The performance optimization configuration of a dataset.
Required: No
Type: PerformanceConfiguration
Update requires: No interruption
Permissions-
A list of resource permissions on the dataset.
Required: No
Type: Array of ResourcePermission
Minimum:
1Maximum:
64Update requires: No interruption
PhysicalTableMap-
Declares the physical tables that are available in the underlying data sources.
Required: No
Type: Object 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
RowLevelPermissionTagConfiguration-
The element you can use to define tags for row-level security.
Required: No
Type: RowLevelPermissionTagConfiguration
Update requires: No interruption
-
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
Required: No
Type: Array of Tag
Minimum:
1Maximum:
200Update requires: No interruption
Return values
Fn::GetAtt
Arn-
The Amazon Resource Name (ARN) of the dataset.
ConsumedSpiceCapacityInBytesCreatedTime-
The time this dataset version was created.
LastUpdatedTime-
The time this dataset version was last updated.
OutputColumns
