AWS::QuickSight::DataSet

Filter View

All

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" : {Key: Value, ...},
      "FolderArns" : [ String, ... ],
      "ImportMode" : String,
      "IngestionWaitPolicy" : IngestionWaitPolicy,
      "LogicalTableMap" : {Key: Value, ...},
      "Name" : String,
      "PerformanceConfiguration" : PerformanceConfiguration,
      "Permissions" : [ ResourcePermission, ... ],
      "PhysicalTableMap" : {Key: Value, ...},
      "RowLevelPermissionDataSet" : RowLevelPermissionDataSet,
      "RowLevelPermissionTagConfiguration" : RowLevelPermissionTagConfiguration,
      "Tags" : [ Tag, ... ]
    }
}

YAML

Type: AWS::QuickSight::DataSet
Properties:
  AwsAccountId: String
  ColumnGroups: 
    - ColumnGroup
  ColumnLevelPermissionRules: 
    - ColumnLevelPermissionRule
  DataSetId: String
  DatasetParameters: 
    - DatasetParameter
  DataSetRefreshProperties: 
    DataSetRefreshProperties
  DataSetUsageConfiguration: 
    DataSetUsageConfiguration
  FieldFolders: 
    Key: Value
  FolderArns: 
    - String
  ImportMode: String
  IngestionWaitPolicy: 
    IngestionWaitPolicy
  LogicalTableMap: 
    Key: Value
  Name: String
  PerformanceConfiguration: 
    PerformanceConfiguration
  Permissions: 
    - ResourcePermission
  PhysicalTableMap: 
    Key: Value
  RowLevelPermissionDataSet: 
    RowLevelPermissionDataSet
  RowLevelPermissionTagConfiguration: 
    RowLevelPermissionTagConfiguration
  Tags: 
    - Tag

Properties

AwsAccountId

The AWS account ID.

Required: No

Type: String

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

Minimum: 12

Maximum: 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: Array of ColumnGroup

Minimum: 1

Maximum: 8

Update requires: No interruption

ColumnLevelPermissionRules

A set of one or more definitions of a ColumnLevelPermissionRule .

Required: No

Type: Array of ColumnLevelPermissionRule

Minimum: 1

Update 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: 0

Maximum: 32

Update 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

FolderArns

Property description not available.

Required: No

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

ImportMode

Indicates whether you want to import the data into SPICE.

Required: No

Type: String

Allowed values: SPICE | DIRECT_QUERY

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: Object 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

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: 1

Maximum: 64

Update 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

Tags

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: 1

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