interface CfnDataSetProps
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.QuickSight.CfnDataSetProps |
 Go | github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSetProps |
 Java | software.amazon.awscdk.services.quicksight.CfnDataSetProps |
 Python | aws_cdk.aws_quicksight.CfnDataSetProps |
 TypeScript | aws-cdk-lib » aws_quicksight » CfnDataSetProps |
Properties for defining a CfnDataSet.
See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html
Example
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.
Properties
| Name | Type | Description |
|---|---|---|
| aws | string | The AWS account ID. |
| column | IResolvable | (IResolvable | Column)[] | Groupings of columns that work together in certain Amazon Quick Sight features. |
| column | IResolvable | (IResolvable | Column)[] | A set of one or more definitions of a ColumnLevelPermissionRule . |
| data | IResolvable | Data | The data preparation configuration associated with this dataset. |
| data | string | An ID for the dataset that you want to create. |
| data | IResolvable | Data | The refresh properties of a dataset. |
| data | IResolvable | Data | The usage configuration to apply to child datasets that reference this dataset as a source. |
| dataset | IResolvable | (IResolvable | Dataset)[] | The parameters that are declared in a dataset. |
| field | IResolvable | { [string]: IResolvable | Field } | The folder that contains fields and nested subfolders for your dataset. |
| folder | string[] | When you create the dataset, Amazon QuickSight adds the dataset to these folders. . |
| import | string | Indicates whether you want to import the data into SPICE. |
| ingestion | IResolvable | Ingestion | The wait policy to use when creating or updating a Dataset. |
| logical | IResolvable | { [string]: IResolvable | Logical } | |
| name? | string | The display name for the dataset. |
| performance | IResolvable | Performance | The performance optimization configuration of a dataset. |
| permissions? | IResolvable | (IResolvable | Resource)[] | A list of resource permissions on the dataset. |
| physical | IResolvable | { [string]: IResolvable | Physical } | Declares the physical tables that are available in the underlying data sources. |
| row | IResolvable | Row | Information about a dataset that contains permissions for row-level security (RLS). |
| row | IResolvable | Row | The configuration of tags on a dataset to set row-level security. |
| semantic | IResolvable | Semantic | The semantic model configuration associated with this dataset. |
| tags? | Cfn[] | Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset. |
| use | string | The usage of the dataset. |
awsAccountId?
Type:
string
(optional)
The AWS account ID.
columnGroups?
Type:
IResolvable | (IResolvable | Column)[]
(optional)
Groupings of columns that work together in certain Amazon Quick Sight features.
Currently, only geospatial hierarchy is supported.
columnLevelPermissionRules?
Type:
IResolvable | (IResolvable | Column)[]
(optional)
A set of one or more definitions of a ColumnLevelPermissionRule .
dataPrepConfiguration?
Type:
IResolvable | Data
(optional)
The data preparation configuration associated with this dataset.
dataSetId?
Type:
string
(optional)
An ID for the dataset that you want to create.
This ID is unique per AWS Region for each AWS account.
dataSetRefreshProperties?
Type:
IResolvable | Data
(optional)
The refresh properties of a dataset.
dataSetUsageConfiguration?
Type:
IResolvable | Data
(optional)
The usage configuration to apply to child datasets that reference this dataset as a source.
datasetParameters?
Type:
IResolvable | (IResolvable | Dataset)[]
(optional)
The parameters that are declared in a dataset.
fieldFolders?
Type:
IResolvable | { [string]: IResolvable | Field }
(optional)
The folder that contains fields and nested subfolders for your dataset.
folderArns?
Type:
string[]
(optional)
<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.
.importMode?
Type:
string
(optional)
Indicates whether you want to import the data into SPICE.
ingestionWaitPolicy?
Type:
IResolvable | Ingestion
(optional)
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.
logicalTableMap?
⚠️ Deprecated: this property has been deprecated
Type:
IResolvable | { [string]: IResolvable | Logical }
(optional)
name?
Type:
string
(optional)
The display name for the dataset.
performanceConfiguration?
Type:
IResolvable | Performance
(optional)
The performance optimization configuration of a dataset.
permissions?
Type:
IResolvable | (IResolvable | Resource)[]
(optional)
A list of resource permissions on the dataset.
physicalTableMap?
Type:
IResolvable | { [string]: IResolvable | Physical }
(optional)
Declares the physical tables that are available in the underlying data sources.
rowLevelPermissionDataSet?
⚠️ Deprecated: this property has been deprecated
Type:
IResolvable | Row
(optional)
<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 Using Row-Level Security (RLS) to Restrict Access to a Dataset in the <i>Amazon QuickSight User Guide.
<p>The option to deny permissions by setting <code>PermissionPolicy to <code>DENY_ACCESS is not supported for new RLS datasets.rowLevelPermissionTagConfiguration?
⚠️ Deprecated: this property has been deprecated
Type:
IResolvable | Row
(optional)
<p>The configuration of tags on a dataset to set row-level security.
semanticModelConfiguration?
Type:
IResolvable | Semantic
(optional)
The semantic model configuration associated with this dataset.
tags?
Type:
Cfn[]
(optional)
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
useAs?
Type:
string
(optional)
The usage of the dataset.