Skip to content
v2.274.0

CfnDataSetProps Struct ​

Properties for defining a CfnDataSet.

Example ​

ts
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties ​

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*string#
The AWS account ID.
columnGroupsIResolvable | IResolvable | CfnDataSet.ColumnGroupProperty[]column_groupstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnGroupProperty]]]columnGroupsIResolvableColumnGroupsIResolvableColumnGroupsinterface{}#
Groupings of columns that work together in certain Amazon Quick Sight features.

Currently, only geospatial hierarchy is supported.

columnLevelPermissionRulesIResolvable | IResolvable | CfnDataSet.ColumnLevelPermissionRuleProperty[]column_level_permission_rulestyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnLevelPermissionRuleProperty]]]columnLevelPermissionRulesIResolvableColumnLevelPermissionRulesIResolvableColumnLevelPermissionRulesinterface{}#
A set of one or more definitions of a `ColumnLevelPermissionRule` .
dataPrepConfigurationIResolvable | CfnDataSet.DataPrepConfigurationPropertydata_prep_configurationtyping.Union[IResolvable, DataPrepConfigurationProperty]dataPrepConfigurationIResolvableDataPrepConfigurationIResolvableDataPrepConfigurationinterface{}#
The data preparation configuration associated with this dataset.
dataSetIdstringdata_set_idstrdataSetIdStringDataSetIdstringDataSetId*string#
An ID for the dataset that you want to create.

This ID is unique per AWS Region for each AWS account.

datasetParametersIResolvable | IResolvable | CfnDataSet.DatasetParameterProperty[]dataset_parameterstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatasetParameterProperty]]]datasetParametersIResolvableDatasetParametersIResolvableDatasetParametersinterface{}#
The parameters that are declared in a dataset.
dataSetRefreshPropertiesIResolvable | CfnDataSet.DataSetRefreshPropertiesPropertydata_set_refresh_propertiestyping.Union[IResolvable, DataSetRefreshPropertiesProperty]dataSetRefreshPropertiesIResolvableDataSetRefreshPropertiesIResolvableDataSetRefreshPropertiesinterface{}#
The refresh properties of a dataset.
dataSetUsageConfigurationIResolvable | CfnDataSet.DataSetUsageConfigurationPropertydata_set_usage_configurationtyping.Union[IResolvable, DataSetUsageConfigurationProperty]dataSetUsageConfigurationIResolvableDataSetUsageConfigurationIResolvableDataSetUsageConfigurationinterface{}#
The usage configuration to apply to child datasets that reference this dataset as a source.
fieldFoldersIResolvable | { [key: string]: IResolvable | CfnDataSet.FieldFolderProperty }field_folderstyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, FieldFolderProperty]]]fieldFoldersIResolvableFieldFoldersIResolvableFieldFoldersinterface{}#
The folder that contains fields and nested subfolders for your dataset.
folderArnsstring[]folder_arnstyping.List[str]folderArnsList<String>FolderArnsstring[]FolderArns*[]*string#
<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>.
importModestringimport_modestrimportModeStringImportModestringImportMode*string#
Indicates whether you want to import the data into SPICE.
ingestionWaitPolicyIResolvable | CfnDataSet.IngestionWaitPolicyPropertyingestion_wait_policytyping.Union[IResolvable, IngestionWaitPolicyProperty]ingestionWaitPolicyIResolvableIngestionWaitPolicyIResolvableIngestionWaitPolicyinterface{}#
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.

logicalTableMapIResolvable | { [key: string]: IResolvable | CfnDataSet.LogicalTableProperty }logical_table_maptyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, LogicalTableProperty]]]logicalTableMapIResolvableLogicalTableMapIResolvableLogicalTableMapinterface{}deprecated#
this property has been deprecated
namestringnamestrnameStringNamestringName*string#
The display name for the dataset.
performanceConfigurationIResolvable | CfnDataSet.PerformanceConfigurationPropertyperformance_configurationtyping.Union[IResolvable, PerformanceConfigurationProperty]performanceConfigurationIResolvablePerformanceConfigurationIResolvablePerformanceConfigurationinterface{}#
The performance optimization configuration of a dataset.
permissionsIResolvable | IResolvable | CfnDataSet.ResourcePermissionProperty[]permissionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsIResolvablePermissionsIResolvablePermissionsinterface{}#
A list of resource permissions on the dataset.
physicalTableMapIResolvable | { [key: string]: IResolvable | CfnDataSet.PhysicalTableProperty }physical_table_maptyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PhysicalTableProperty]]]physicalTableMapIResolvablePhysicalTableMapIResolvablePhysicalTableMapinterface{}#
Declares the physical tables that are available in the underlying data sources.
rowLevelPermissionDataSetIResolvable | CfnDataSet.RowLevelPermissionDataSetPropertyrow_level_permission_data_settyping.Union[IResolvable, RowLevelPermissionDataSetProperty]rowLevelPermissionDataSetIResolvableRowLevelPermissionDataSetIResolvableRowLevelPermissionDataSetinterface{}deprecated#
this property has been deprecated
notes

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>

rowLevelPermissionTagConfigurationIResolvable | CfnDataSet.RowLevelPermissionTagConfigurationPropertyrow_level_permission_tag_configurationtyping.Union[IResolvable, RowLevelPermissionTagConfigurationProperty]rowLevelPermissionTagConfigurationIResolvableRowLevelPermissionTagConfigurationIResolvableRowLevelPermissionTagConfigurationinterface{}deprecated#
this property has been deprecated

</p>

semanticModelConfigurationIResolvable | CfnDataSet.SemanticModelConfigurationPropertysemantic_model_configurationtyping.Union[IResolvable, SemanticModelConfigurationProperty]semanticModelConfigurationIResolvableSemanticModelConfigurationIResolvableSemanticModelConfigurationinterface{}#
The semantic model configuration associated with this dataset.
tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
useAsstringuse_asstruseAsStringUseAsstringUseAs*string#
The usage of the dataset.