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
awsAccountIdoptionalstringaws_account_idoptionalstrawsAccountIdoptionalStringAwsAccountIdoptionalstringAwsAccountIdoptional*string#The AWS account ID.
columnGroupsoptionalIResolvable | IResolvable | CfnDataSet.ColumnGroupProperty[]column_groupsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnGroupProperty]]]columnGroupsoptionalIResolvableColumnGroupsoptionalIResolvableColumnGroupsoptionalinterface{}#Groupings of columns that work together in certain Amazon Quick Sight features.
Currently, only geospatial hierarchy is supported.
columnLevelPermissionRulesoptionalIResolvable | IResolvable | CfnDataSet.ColumnLevelPermissionRuleProperty[]column_level_permission_rulesoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ColumnLevelPermissionRuleProperty]]]columnLevelPermissionRulesoptionalIResolvableColumnLevelPermissionRulesoptionalIResolvableColumnLevelPermissionRulesoptionalinterface{}#A set of one or more definitions of a `ColumnLevelPermissionRule` .
dataPrepConfigurationoptionalIResolvable | CfnDataSet.DataPrepConfigurationPropertydata_prep_configurationoptionaltyping.Union[IResolvable, DataPrepConfigurationProperty]dataPrepConfigurationoptionalIResolvableDataPrepConfigurationoptionalIResolvableDataPrepConfigurationoptionalinterface{}#The data preparation configuration associated with this dataset.
dataSetIdoptionalstringdata_set_idoptionalstrdataSetIdoptionalStringDataSetIdoptionalstringDataSetIdoptional*string#An ID for the dataset that you want to create.
This ID is unique per AWS Region for each AWS account.
datasetParametersoptionalIResolvable | IResolvable | CfnDataSet.DatasetParameterProperty[]dataset_parametersoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, DatasetParameterProperty]]]datasetParametersoptionalIResolvableDatasetParametersoptionalIResolvableDatasetParametersoptionalinterface{}#The parameters that are declared in a dataset.
dataSetRefreshPropertiesoptionalIResolvable | CfnDataSet.DataSetRefreshPropertiesPropertydata_set_refresh_propertiesoptionaltyping.Union[IResolvable, DataSetRefreshPropertiesProperty]dataSetRefreshPropertiesoptionalIResolvableDataSetRefreshPropertiesoptionalIResolvableDataSetRefreshPropertiesoptionalinterface{}#The refresh properties of a dataset.
dataSetUsageConfigurationoptionalIResolvable | CfnDataSet.DataSetUsageConfigurationPropertydata_set_usage_configurationoptionaltyping.Union[IResolvable, DataSetUsageConfigurationProperty]dataSetUsageConfigurationoptionalIResolvableDataSetUsageConfigurationoptionalIResolvableDataSetUsageConfigurationoptionalinterface{}#The usage configuration to apply to child datasets that reference this dataset as a source.
fieldFoldersoptionalIResolvable | { [key: string]: IResolvable | CfnDataSet.FieldFolderProperty }field_foldersoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, FieldFolderProperty]]]fieldFoldersoptionalIResolvableFieldFoldersoptionalIResolvableFieldFoldersoptionalinterface{}#The folder that contains fields and nested subfolders for your dataset.
folderArnsoptionalstring[]folder_arnsoptionaltyping.List[str]folderArnsoptionalList<String>FolderArnsoptionalstring[]FolderArnsoptional*[]*string#<p>When you create the dataset, Amazon QuickSight adds the dataset to these folders.</p>.
importModeoptionalstringimport_modeoptionalstrimportModeoptionalStringImportModeoptionalstringImportModeoptional*string#Indicates whether you want to import the data into SPICE.
ingestionWaitPolicyoptionalIResolvable | CfnDataSet.IngestionWaitPolicyPropertyingestion_wait_policyoptionaltyping.Union[IResolvable, IngestionWaitPolicyProperty]ingestionWaitPolicyoptionalIResolvableIngestionWaitPolicyoptionalIResolvableIngestionWaitPolicyoptionalinterface{}#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.
logicalTableMapoptionalIResolvable | { [key: string]: IResolvable | CfnDataSet.LogicalTableProperty }logical_table_mapoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, LogicalTableProperty]]]logicalTableMapoptionalIResolvableLogicalTableMapoptionalIResolvableLogicalTableMapoptionalinterface{}deprecated#this property has been deprecated
The display name for the dataset.
performanceConfigurationoptionalIResolvable | CfnDataSet.PerformanceConfigurationPropertyperformance_configurationoptionaltyping.Union[IResolvable, PerformanceConfigurationProperty]performanceConfigurationoptionalIResolvablePerformanceConfigurationoptionalIResolvablePerformanceConfigurationoptionalinterface{}#The performance optimization configuration of a dataset.
permissionsoptionalIResolvable | IResolvable | CfnDataSet.ResourcePermissionProperty[]permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsoptionalIResolvablePermissionsoptionalIResolvablePermissionsoptionalinterface{}#A list of resource permissions on the dataset.
physicalTableMapoptionalIResolvable | { [key: string]: IResolvable | CfnDataSet.PhysicalTableProperty }physical_table_mapoptionaltyping.Union[IResolvable, typing.Mapping[str, typing.Union[IResolvable, PhysicalTableProperty]]]physicalTableMapoptionalIResolvablePhysicalTableMapoptionalIResolvablePhysicalTableMapoptionalinterface{}#Declares the physical tables that are available in the underlying data sources.
rowLevelPermissionDataSetoptionalIResolvable | CfnDataSet.RowLevelPermissionDataSetPropertyrow_level_permission_data_setoptionaltyping.Union[IResolvable, RowLevelPermissionDataSetProperty]rowLevelPermissionDataSetoptionalIResolvableRowLevelPermissionDataSetoptionalIResolvableRowLevelPermissionDataSetoptionalinterface{}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>
rowLevelPermissionTagConfigurationoptionalIResolvable | CfnDataSet.RowLevelPermissionTagConfigurationPropertyrow_level_permission_tag_configurationoptionaltyping.Union[IResolvable, RowLevelPermissionTagConfigurationProperty]rowLevelPermissionTagConfigurationoptionalIResolvableRowLevelPermissionTagConfigurationoptionalIResolvableRowLevelPermissionTagConfigurationoptionalinterface{}deprecated#this property has been deprecated
</p>
semanticModelConfigurationoptionalIResolvable | CfnDataSet.SemanticModelConfigurationPropertysemantic_model_configurationoptionaltyping.Union[IResolvable, SemanticModelConfigurationProperty]semanticModelConfigurationoptionalIResolvableSemanticModelConfigurationoptionalIResolvableSemanticModelConfigurationoptionalinterface{}#The semantic model configuration associated with this dataset.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
The usage of the dataset.