Package software.amazon.awscdk.services.quicksight

Interface CfnDataSetProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSetProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-13T16:10:11.728Z")
@Stability(Stable)
public interface CfnDataSetProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDataSet.

Example:

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSetProps.Builder	A builder for CfnDataSetProps
static final class	CfnDataSetProps.Jsii$Proxy	An implementation for CfnDataSetProps

Method Summary

Modifier and Type	Method	Description
static CfnDataSetProps.Builder	builder()
default String	getAwsAccountId()	The AWS account ID.
default Object	getColumnGroups()	Groupings of columns that work together in certain Amazon Quick Sight features.
default Object	getColumnLevelPermissionRules()	A set of one or more definitions of a ColumnLevelPermissionRule .
default Object	getDataPrepConfiguration()	The data preparation configuration associated with this dataset.
default String	getDataSetId()	An ID for the dataset that you want to create.
default Object	getDatasetParameters()	The parameters that are declared in a dataset.
default Object	getDataSetRefreshProperties()	The refresh properties of a dataset.
default Object	getDataSetUsageConfiguration()	The usage configuration to apply to child datasets that reference this dataset as a source.
default Object	getFieldFolders()	The folder that contains fields and nested subfolders for your dataset.
default List<String>	getFolderArns()	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
default String	getImportMode()	Indicates whether you want to import the data into SPICE.
default Object	getIngestionWaitPolicy()	The wait policy to use when creating or updating a Dataset.
default Object	getLogicalTableMap()	Deprecated. this property has been deprecated
default String	getName()	The display name for the dataset.
default Object	getPerformanceConfiguration()	The performance optimization configuration of a dataset.
default Object	getPermissions()	A list of resource permissions on the dataset.
default Object	getPhysicalTableMap()	Declares the physical tables that are available in the underlying data sources.
default Object	getRowLevelPermissionDataSet()	Deprecated. this property has been deprecated
default Object	getRowLevelPermissionTagConfiguration()	Deprecated. this property has been deprecated
default Object	getSemanticModelConfiguration()	The semantic model configuration associated with this dataset.
default List<CfnTag>	getTags()	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
default String	getUseAs()	The usage of the dataset.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAwsAccountId

@Stability(Stable)
@Nullable
default String getAwsAccountId()

The AWS account ID.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-awsaccountid

getColumnGroups

@Stability(Stable)
@Nullable
default Object getColumnGroups()

Groupings of columns that work together in certain Amazon Quick Sight features.

Currently, only geospatial hierarchy is supported.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.ColumnGroupProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columngroups

getColumnLevelPermissionRules

@Stability(Stable)
@Nullable
default Object getColumnLevelPermissionRules()

A set of one or more definitions of a ColumnLevelPermissionRule .

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.ColumnLevelPermissionRuleProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-columnlevelpermissionrules

getDataPrepConfiguration

@Stability(Stable)
@Nullable
default Object getDataPrepConfiguration()

The data preparation configuration associated with this dataset.

Returns union: either IResolvable or CfnDataSet.DataPrepConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-dataprepconfiguration

getDataSetId

@Stability(Stable)
@Nullable
default String getDataSetId()

An ID for the dataset that you want to create.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetid

getDatasetParameters

@Stability(Stable)
@Nullable
default Object getDatasetParameters()

The parameters that are declared in a dataset.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.DatasetParameterProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetparameters

getDataSetRefreshProperties

@Stability(Stable)
@Nullable
default Object getDataSetRefreshProperties()

The refresh properties of a dataset.

Returns union: either IResolvable or CfnDataSet.DataSetRefreshPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetrefreshproperties

getDataSetUsageConfiguration

@Stability(Stable)
@Nullable
default Object getDataSetUsageConfiguration()

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

Returns union: either IResolvable or CfnDataSet.DataSetUsageConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-datasetusageconfiguration

getFieldFolders

@Stability(Stable)
@Nullable
default Object getFieldFolders()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDataSet.FieldFolderProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-fieldfolders

getFolderArns

@Stability(Stable)
@Nullable
default List<String> getFolderArns()

When you create the dataset, Amazon QuickSight adds the dataset to these folders.

.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-folderarns

getImportMode

@Stability(Stable)
@Nullable
default String getImportMode()

Indicates whether you want to import the data into SPICE.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-importmode

getIngestionWaitPolicy

@Stability(Stable)
@Nullable
default Object getIngestionWaitPolicy()

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.

Returns union: either IResolvable or CfnDataSet.IngestionWaitPolicyProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-ingestionwaitpolicy

getLogicalTableMap

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getLogicalTableMap()

Deprecated.

this property has been deprecated

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDataSet.LogicalTableProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-logicaltablemap

getName

@Stability(Stable)
@Nullable
default String getName()

The display name for the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-name

getPerformanceConfiguration

@Stability(Stable)
@Nullable
default Object getPerformanceConfiguration()

The performance optimization configuration of a dataset.

Returns union: either IResolvable or CfnDataSet.PerformanceConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-performanceconfiguration

getPermissions

@Stability(Stable)
@Nullable
default Object getPermissions()

A list of resource permissions on the dataset.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnDataSet.ResourcePermissionProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-permissions

getPhysicalTableMap

@Stability(Stable)
@Nullable
default Object getPhysicalTableMap()

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

Returns union: either IResolvable or Mapinvalid input: '<'String, either IResolvable or CfnDataSet.PhysicalTableProperty>

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-physicaltablemap

getRowLevelPermissionDataSet

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getRowLevelPermissionDataSet()

Deprecated.

this property has been deprecated

(deprecated)

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 Amazon QuickSight User Guide.

The option to deny permissions by setting PermissionPolicy to DENY_ACCESS is not supported for new RLS datasets.

Returns union: either IResolvable or CfnDataSet.RowLevelPermissionDataSetProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-rowlevelpermissiondataset

getRowLevelPermissionTagConfiguration

@Stability(Deprecated)
@Deprecated
@Nullable
default Object getRowLevelPermissionTagConfiguration()

Deprecated.

this property has been deprecated

(deprecated)

The configuration of tags on a dataset to set row-level security.

Returns union: either IResolvable or CfnDataSet.RowLevelPermissionTagConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-rowlevelpermissiontagconfiguration

getSemanticModelConfiguration

@Stability(Stable)
@Nullable
default Object getSemanticModelConfiguration()

The semantic model configuration associated with this dataset.

Returns union: either IResolvable or CfnDataSet.SemanticModelConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-semanticmodelconfiguration

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-tags

getUseAs

@Stability(Stable)
@Nullable
default String getUseAs()

The usage of the dataset.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-dataset.html#cfn-quicksight-dataset-useas

builder

@Stability(Stable)
static CfnDataSetProps.Builder builder()

Returns:

a CfnDataSetProps.Builder of CfnDataSetProps