AWS Fundamentals Logo
AWS Fundamentals
L1 ConstructAWS::QuickSight::DataSet

CfnDataSet

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

Import

import { CfnDataSet } from 'aws-cdk-lib/aws-quicksight';

Or use the module namespace:

import * as quicksight from 'aws-cdk-lib/aws-quicksight';
// quicksight.CfnDataSet

Properties

Configuration passed to the constructor as CfnDataSetProps.

awsAccountIdOptional
string

The AWS account ID.

columnGroupsOptional
IResolvable | IResolvable | ColumnGroupProperty[]

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

columnLevelPermissionRulesOptional
IResolvable | IResolvable | ColumnLevelPermissionRuleProperty[]

A set of one or more definitions of a `ColumnLevelPermissionRule` .

dataPrepConfigurationOptional
IResolvable | DataPrepConfigurationProperty

The data preparation configuration associated with this dataset.

dataSetIdOptional
string

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

datasetParametersOptional
IResolvable | IResolvable | DatasetParameterProperty[]

The parameters that are declared in a dataset.

dataSetRefreshPropertiesOptional
IResolvable | DataSetRefreshPropertiesProperty

The refresh properties of a dataset.

dataSetUsageConfigurationOptional
IResolvable | DataSetUsageConfigurationProperty

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

fieldFoldersOptional
IResolvable | { [key: string]: IResolvable | FieldFolderProperty }

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

folderArnsOptional
string[]

<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>.

importModeOptional
string

Indicates whether you want to import the data into SPICE.

ingestionWaitPolicyOptional
IResolvable | IngestionWaitPolicyProperty

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.

logicalTableMapOptionalDeprecated
IResolvable | { [key: string]: IResolvable | LogicalTableProperty }

Deprecated: this property has been deprecated

nameOptional
string

The display name for the dataset.

performanceConfigurationOptional
IResolvable | PerformanceConfigurationProperty

The performance optimization configuration of a dataset.

permissionsOptional
IResolvable | IResolvable | ResourcePermissionProperty[]

A list of resource permissions on the dataset.

physicalTableMapOptional
IResolvable | { [key: string]: IResolvable | PhysicalTableProperty }

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

rowLevelPermissionDataSetOptionalDeprecated
IResolvable | RowLevelPermissionDataSetProperty

<p>Information about a dataset that contains permissions for row-level security (RLS). The permissions dataset maps fields to users or groups. For more information, see <a href="https://docs.aws.amazon.com/quicksight/latest/user/restrict-access-to-a-data-set-using-row-level-security.html">Using Row-Level Security (RLS) to Restrict Access to a Dataset</a> in the <i>Amazon QuickSight User Guide</i>.</p> <p>The option to deny permissions by setting <code>PermissionPolicy</code> to <code>DENY_ACCESS</code> is not supported for new RLS datasets.</p>

Deprecated: this property has been deprecated

rowLevelPermissionTagConfigurationOptionalDeprecated
IResolvable | RowLevelPermissionTagConfigurationProperty

<p>The configuration of tags on a dataset to set row-level security. </p>

Deprecated: this property has been deprecated

semanticModelConfigurationOptional
IResolvable | SemanticModelConfigurationProperty

The semantic model configuration associated with this dataset.

tagsOptional
CfnTag[]

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

useAsOptional
string

The usage of the dataset.

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QuickSight::DataSetView in CloudFormation Explorer

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

LevelL1 (CloudFormation)
Moduleaws-quicksight
CFN TypeAWS::QuickSight::DataSet
Properties22

Related Constructs

Explore This Service

External Links