Package software.amazon.awscdk.services.quicksight

Class CfnDataSet

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.quicksight.CfnDataSet

All Implemented Interfaces:

IInspectable, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.110.0 (build 336b265)",
           date="2025-04-22T23:08:18.423Z")
@Stability(Stable)
public class CfnDataSet
extends CfnResource
implements IInspectable, ITaggable

Creates a dataset.

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 Object tagRuleConfigurations;
 CfnDataSet cfnDataSet = CfnDataSet.Builder.create(this, "MyCfnDataSet")
         .awsAccountId("awsAccountId")
         .columnGroups(List.of(ColumnGroupProperty.builder()
                 .geoSpatialColumnGroup(GeoSpatialColumnGroupProperty.builder()
                         .columns(List.of("columns"))
                         .name("name")
                         // the properties below are optional
                         .countryCode("countryCode")
                         .build())
                 .build()))
         .columnLevelPermissionRules(List.of(ColumnLevelPermissionRuleProperty.builder()
                 .columnNames(List.of("columnNames"))
                 .principals(List.of("principals"))
                 .build()))
         .dataSetId("dataSetId")
         .datasetParameters(List.of(DatasetParameterProperty.builder()
                 .dateTimeDatasetParameter(DateTimeDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(DateTimeDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of("staticValues"))
                                 .build())
                         .timeGranularity("timeGranularity")
                         .build())
                 .decimalDatasetParameter(DecimalDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(DecimalDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of(123))
                                 .build())
                         .build())
                 .integerDatasetParameter(IntegerDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(IntegerDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of(123))
                                 .build())
                         .build())
                 .stringDatasetParameter(StringDatasetParameterProperty.builder()
                         .id("id")
                         .name("name")
                         .valueType("valueType")
                         // the properties below are optional
                         .defaultValues(StringDatasetParameterDefaultValuesProperty.builder()
                                 .staticValues(List.of("staticValues"))
                                 .build())
                         .build())
                 .build()))
         .dataSetRefreshProperties(DataSetRefreshPropertiesProperty.builder()
                 .failureConfiguration(RefreshFailureConfigurationProperty.builder()
                         .emailAlert(RefreshFailureEmailAlertProperty.builder()
                                 .alertStatus("alertStatus")
                                 .build())
                         .build())
                 .refreshConfiguration(RefreshConfigurationProperty.builder()
                         .incrementalRefresh(IncrementalRefreshProperty.builder()
                                 .lookbackWindow(LookbackWindowProperty.builder()
                                         .columnName("columnName")
                                         .size(123)
                                         .sizeUnit("sizeUnit")
                                         .build())
                                 .build())
                         .build())
                 .build())
         .dataSetUsageConfiguration(DataSetUsageConfigurationProperty.builder()
                 .disableUseAsDirectQuerySource(false)
                 .disableUseAsImportedSource(false)
                 .build())
         .fieldFolders(Map.of(
                 "fieldFoldersKey", FieldFolderProperty.builder()
                         .columns(List.of("columns"))
                         .description("description")
                         .build()))
         .folderArns(List.of("folderArns"))
         .importMode("importMode")
         .ingestionWaitPolicy(IngestionWaitPolicyProperty.builder()
                 .ingestionWaitTimeInHours(123)
                 .waitForSpiceIngestion(false)
                 .build())
         .logicalTableMap(Map.of(
                 "logicalTableMapKey", LogicalTableProperty.builder()
                         .alias("alias")
                         // the properties below are optional
                         .dataTransforms(List.of(TransformOperationProperty.builder()
                                 .castColumnTypeOperation(CastColumnTypeOperationProperty.builder()
                                         .columnName("columnName")
                                         .newColumnType("newColumnType")
                                         // the properties below are optional
                                         .format("format")
                                         .subType("subType")
                                         .build())
                                 .createColumnsOperation(CreateColumnsOperationProperty.builder()
                                         .columns(List.of(CalculatedColumnProperty.builder()
                                                 .columnId("columnId")
                                                 .columnName("columnName")
                                                 .expression("expression")
                                                 .build()))
                                         .build())
                                 .filterOperation(FilterOperationProperty.builder()
                                         .conditionExpression("conditionExpression")
                                         .build())
                                 .overrideDatasetParameterOperation(OverrideDatasetParameterOperationProperty.builder()
                                         .parameterName("parameterName")
                                         // the properties below are optional
                                         .newDefaultValues(NewDefaultValuesProperty.builder()
                                                 .dateTimeStaticValues(List.of("dateTimeStaticValues"))
                                                 .decimalStaticValues(List.of(123))
                                                 .integerStaticValues(List.of(123))
                                                 .stringStaticValues(List.of("stringStaticValues"))
                                                 .build())
                                         .newParameterName("newParameterName")
                                         .build())
                                 .projectOperation(ProjectOperationProperty.builder()
                                         .projectedColumns(List.of("projectedColumns"))
                                         .build())
                                 .renameColumnOperation(RenameColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         // the properties below are optional
                                         .newColumnName("newColumnName")
                                         .build())
                                 .tagColumnOperation(TagColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .tags(List.of(ColumnTagProperty.builder()
                                                 .columnDescription(ColumnDescriptionProperty.builder()
                                                         .text("text")
                                                         .build())
                                                 .columnGeographicRole("columnGeographicRole")
                                                 .build()))
                                         .build())
                                 .untagColumnOperation(UntagColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .tagNames(List.of("tagNames"))
                                         .build())
                                 .build()))
                         .source(LogicalTableSourceProperty.builder()
                                 .dataSetArn("dataSetArn")
                                 .joinInstruction(JoinInstructionProperty.builder()
                                         .leftOperand("leftOperand")
                                         .onClause("onClause")
                                         .rightOperand("rightOperand")
                                         .type("type")
                                         // the properties below are optional
                                         .leftJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                                 .uniqueKey(false)
                                                 .build())
                                         .rightJoinKeyProperties(JoinKeyPropertiesProperty.builder()
                                                 .uniqueKey(false)
                                                 .build())
                                         .build())
                                 .physicalTableId("physicalTableId")
                                 .build())
                         .build()))
         .name("name")
         .performanceConfiguration(PerformanceConfigurationProperty.builder()
                 .uniqueKeys(List.of(UniqueKeyProperty.builder()
                         .columnNames(List.of("columnNames"))
                         .build()))
                 .build())
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .physicalTableMap(Map.of(
                 "physicalTableMapKey", PhysicalTableProperty.builder()
                         .customSql(CustomSqlProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .name("name")
                                 .sqlQuery("sqlQuery")
                                 // the properties below are optional
                                 .columns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .build())
                         .relationalTable(RelationalTableProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 .name("name")
                                 // the properties below are optional
                                 .catalog("catalog")
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .schema("schema")
                                 .build())
                         .s3Source(S3SourceProperty.builder()
                                 .dataSourceArn("dataSourceArn")
                                 // the properties below are optional
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .subType("subType")
                                         .build()))
                                 .uploadSettings(UploadSettingsProperty.builder()
                                         .containsHeader(false)
                                         .delimiter("delimiter")
                                         .format("format")
                                         .startFromRow(123)
                                         .textQualifier("textQualifier")
                                         .build())
                                 .build())
                         .build()))
         .rowLevelPermissionDataSet(RowLevelPermissionDataSetProperty.builder()
                 .arn("arn")
                 .permissionPolicy("permissionPolicy")
                 // the properties below are optional
                 .formatVersion("formatVersion")
                 .namespace("namespace")
                 .status("status")
                 .build())
         .rowLevelPermissionTagConfiguration(RowLevelPermissionTagConfigurationProperty.builder()
                 .tagRules(List.of(RowLevelPermissionTagRuleProperty.builder()
                         .columnName("columnName")
                         .tagKey("tagKey")
                         // the properties below are optional
                         .matchAllValue("matchAllValue")
                         .tagMultiValueDelimiter("tagMultiValueDelimiter")
                         .build()))
                 // the properties below are optional
                 .status("status")
                 .tagRuleConfigurations(tagRuleConfigurations)
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useAs("useAs")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnDataSet.Builder	A fluent builder for CfnDataSet.
static interface	CfnDataSet.CalculatedColumnProperty	A calculated column for a dataset.
static interface	CfnDataSet.CastColumnTypeOperationProperty	A transform operation that casts a column to a different type.
static interface	CfnDataSet.ColumnDescriptionProperty	Metadata that contains a description for a column.
static interface	CfnDataSet.ColumnGroupProperty	Groupings of columns that work together in certain Amazon QuickSight features.
static interface	CfnDataSet.ColumnLevelPermissionRuleProperty	A rule defined to grant access on one or more restricted columns.
static interface	CfnDataSet.ColumnTagProperty	A tag for a column in a [TagColumnOperation](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_TagColumnOperation.html) structure.
static interface	CfnDataSet.CreateColumnsOperationProperty	A transform operation that creates calculated columns.
static interface	CfnDataSet.CustomSqlProperty	A physical table type built from the results of the custom SQL query.
static interface	CfnDataSet.DatasetParameterProperty	The parameter declarations of the dataset.
static interface	CfnDataSet.DataSetRefreshPropertiesProperty	The refresh properties of a dataset.
static interface	CfnDataSet.DataSetUsageConfigurationProperty	The usage configuration to apply to child datasets that reference this dataset as a source.
static interface	CfnDataSet.DateTimeDatasetParameterDefaultValuesProperty	The default values of a date time parameter.
static interface	CfnDataSet.DateTimeDatasetParameterProperty	A date time parameter that is created in the dataset.
static interface	CfnDataSet.DecimalDatasetParameterDefaultValuesProperty	A list of default values for a given decimal parameter.
static interface	CfnDataSet.DecimalDatasetParameterProperty	A decimal parameter that is created in the dataset.
static interface	CfnDataSet.FieldFolderProperty	A FieldFolder element is a folder that contains fields and nested subfolders.
static interface	CfnDataSet.FilterOperationProperty	A transform operation that filters rows based on a condition.
static interface	CfnDataSet.GeoSpatialColumnGroupProperty	Geospatial column group that denotes a hierarchy.
static interface	CfnDataSet.IncrementalRefreshProperty	The incremental refresh configuration for a dataset.
static interface	CfnDataSet.IngestionWaitPolicyProperty	The wait policy to use when creating or updating a Dataset.
static interface	CfnDataSet.InputColumnProperty	Metadata for a column that is used as the input of a transform operation.
static interface	CfnDataSet.IntegerDatasetParameterDefaultValuesProperty	A list of default values for a given integer parameter.
static interface	CfnDataSet.IntegerDatasetParameterProperty	An integer parameter that is created in the dataset.
static interface	CfnDataSet.JoinInstructionProperty	The instructions associated with a join.
static interface	CfnDataSet.JoinKeyPropertiesProperty	Properties associated with the columns participating in a join.
static interface	CfnDataSet.LogicalTableProperty	A logical table is a unit that joins and that data transformations operate on.
static interface	CfnDataSet.LogicalTableSourceProperty	Information about the source of a logical table.
static interface	CfnDataSet.LookbackWindowProperty	The lookback window setup of an incremental refresh configuration.
static interface	CfnDataSet.NewDefaultValuesProperty	The new default values for the parameter.
static interface	CfnDataSet.OutputColumnProperty	Output column.
static interface	CfnDataSet.OverrideDatasetParameterOperationProperty	A transform operation that overrides the dataset parameter values that are defined in another dataset.
static interface	CfnDataSet.PerformanceConfigurationProperty	Example:
static interface	CfnDataSet.PhysicalTableProperty	A view of a data source that contains information about the shape of the data in the underlying source.
static interface	CfnDataSet.ProjectOperationProperty	A transform operation that projects columns.
static interface	CfnDataSet.RefreshConfigurationProperty	The refresh configuration of a dataset.
static interface	CfnDataSet.RefreshFailureConfigurationProperty	The failure configuration of a dataset.
static interface	CfnDataSet.RefreshFailureEmailAlertProperty	The configuration settings for the email alerts that are sent when a dataset refresh fails.
static interface	CfnDataSet.RelationalTableProperty	A physical table type for relational data sources.
static interface	CfnDataSet.RenameColumnOperationProperty	A transform operation that renames a column.
static interface	CfnDataSet.ResourcePermissionProperty	Permission for the resource.
static interface	CfnDataSet.RowLevelPermissionDataSetProperty	Information about a dataset that contains permissions for row-level security (RLS).
static interface	CfnDataSet.RowLevelPermissionTagConfigurationProperty	The element you can use to define tags for row-level security.
static interface	CfnDataSet.RowLevelPermissionTagRuleProperty	A set of rules associated with a tag.
static interface	CfnDataSet.S3SourceProperty	A physical table type for an S3 data source.
static interface	CfnDataSet.StringDatasetParameterDefaultValuesProperty	A list of default values for a given string dataset parameter type.
static interface	CfnDataSet.StringDatasetParameterProperty	A string parameter that is created in the dataset.
static interface	CfnDataSet.TagColumnOperationProperty	A transform operation that tags a column with additional information.
static interface	CfnDataSet.TransformOperationProperty	A data transformation on a logical table.
static interface	CfnDataSet.UniqueKeyProperty	Example:
static interface	CfnDataSet.UntagColumnOperationProperty	A transform operation that removes tags associated with a column.
static interface	CfnDataSet.UploadSettingsProperty	Information about the format for a source file or files.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable

ITaggable.Jsii$Default, ITaggable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnDataSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDataSet(software.amazon.jsii.JsiiObjectRef objRef)
	CfnDataSet(software.constructs.Construct scope, String id)
	CfnDataSet(software.constructs.Construct scope, String id, CfnDataSetProps props)

Method Summary

Modifier and Type	Method	Description
String	getAttrArn()	The Amazon Resource Name (ARN) of the dataset.
IResolvable	getAttrConsumedSpiceCapacityInBytes()	The amount of SPICE capacity used by this dataset.
String	getAttrCreatedTime()	The time this dataset version was created.
String	getAttrLastUpdatedTime()	The time this dataset version was last updated.
IResolvable	getAttrOutputColumns()	The list of columns after all transforms.
String	getAwsAccountId()	The AWS account ID.
protected Map<String,Object>	getCfnProperties()
Object	getColumnGroups()	Groupings of columns that work together in certain Amazon QuickSight features.
Object	getColumnLevelPermissionRules()	A set of one or more definitions of a ColumnLevelPermissionRule .
String	getDataSetId()	An ID for the dataset that you want to create.
Object	getDatasetParameters()	The parameters that are declared in a dataset.
Object	getDataSetRefreshProperties()	The refresh properties of a dataset.
Object	getDataSetUsageConfiguration()	The usage configuration to apply to child datasets that reference this dataset as a source.
Object	getFieldFolders()	The folder that contains fields and nested subfolders for your dataset.
List<String>	getFolderArns()	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
String	getImportMode()	Indicates whether you want to import the data into SPICE.
Object	getIngestionWaitPolicy()	The wait policy to use when creating or updating a Dataset.
Object	getLogicalTableMap()	Configures the combination and transformation of the data from the physical tables.
String	getName()	The display name for the dataset.
Object	getPerformanceConfiguration()	The performance optimization configuration of a dataset.
Object	getPermissions()	A list of resource permissions on the dataset.
Object	getPhysicalTableMap()	Declares the physical tables that are available in the underlying data sources.
Object	getRowLevelPermissionDataSet()	The row-level security configuration for the data that you want to create.
Object	getRowLevelPermissionTagConfiguration()	The element you can use to define tags for row-level security.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
String	getUseAs()	The usage of the dataset.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value)	The AWS account ID.
void	setColumnGroups(List<Object> value)	Groupings of columns that work together in certain Amazon QuickSight features.
void	setColumnGroups(IResolvable value)	Groupings of columns that work together in certain Amazon QuickSight features.
void	setColumnLevelPermissionRules(List<Object> value)	A set of one or more definitions of a ColumnLevelPermissionRule .
void	setColumnLevelPermissionRules(IResolvable value)	A set of one or more definitions of a ColumnLevelPermissionRule .
void	setDataSetId(String value)	An ID for the dataset that you want to create.
void	setDatasetParameters(List<Object> value)	The parameters that are declared in a dataset.
void	setDatasetParameters(IResolvable value)	The parameters that are declared in a dataset.
void	setDataSetRefreshProperties(IResolvable value)	The refresh properties of a dataset.
void	setDataSetRefreshProperties(CfnDataSet.DataSetRefreshPropertiesProperty value)	The refresh properties of a dataset.
void	setDataSetUsageConfiguration(IResolvable value)	The usage configuration to apply to child datasets that reference this dataset as a source.
void	setDataSetUsageConfiguration(CfnDataSet.DataSetUsageConfigurationProperty value)	The usage configuration to apply to child datasets that reference this dataset as a source.
void	setFieldFolders(Map<String,Object> value)	The folder that contains fields and nested subfolders for your dataset.
void	setFieldFolders(IResolvable value)	The folder that contains fields and nested subfolders for your dataset.
void	setFolderArns(List<String> value)	When you create the dataset, Amazon QuickSight adds the dataset to these folders.
void	setImportMode(String value)	Indicates whether you want to import the data into SPICE.
void	setIngestionWaitPolicy(IResolvable value)	The wait policy to use when creating or updating a Dataset.
void	setIngestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty value)	The wait policy to use when creating or updating a Dataset.
void	setLogicalTableMap(Map<String,Object> value)	Configures the combination and transformation of the data from the physical tables.
void	setLogicalTableMap(IResolvable value)	Configures the combination and transformation of the data from the physical tables.
void	setName(String value)	The display name for the dataset.
void	setPerformanceConfiguration(IResolvable value)	The performance optimization configuration of a dataset.
void	setPerformanceConfiguration(CfnDataSet.PerformanceConfigurationProperty value)	The performance optimization configuration of a dataset.
void	setPermissions(List<Object> value)	A list of resource permissions on the dataset.
void	setPermissions(IResolvable value)	A list of resource permissions on the dataset.
void	setPhysicalTableMap(Map<String,Object> value)	Declares the physical tables that are available in the underlying data sources.
void	setPhysicalTableMap(IResolvable value)	Declares the physical tables that are available in the underlying data sources.
void	setRowLevelPermissionDataSet(IResolvable value)	The row-level security configuration for the data that you want to create.
void	setRowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty value)	The row-level security configuration for the data that you want to create.
void	setRowLevelPermissionTagConfiguration(IResolvable value)	The element you can use to define tags for row-level security.
void	setRowLevelPermissionTagConfiguration(CfnDataSet.RowLevelPermissionTagConfigurationProperty value)	The element you can use to define tags for row-level security.
void	setTagsRaw(List<CfnTag> value)	Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.
void	setUseAs(String value)	The usage of the dataset.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnDataSet

protected CfnDataSet(software.amazon.jsii.JsiiObjectRef objRef)

CfnDataSet

protected CfnDataSet(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDataSet

@Stability(Stable)
public CfnDataSet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @Nullable
 CfnDataSetProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties.

CfnDataSet

@Stability(Stable)
public CfnDataSet(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the dataset.

getAttrConsumedSpiceCapacityInBytes

@Stability(Stable)
@NotNull
public IResolvable getAttrConsumedSpiceCapacityInBytes()

The amount of SPICE capacity used by this dataset.

This is 0 if the dataset isn't imported into SPICE.

getAttrCreatedTime

@Stability(Stable)
@NotNull
public String getAttrCreatedTime()

The time this dataset version was created.

getAttrLastUpdatedTime

@Stability(Stable)
@NotNull
public String getAttrLastUpdatedTime()

The time this dataset version was last updated.

getAttrOutputColumns

@Stability(Stable)
@NotNull
public IResolvable getAttrOutputColumns()

The list of columns after all transforms.

These columns are available in templates, analyses, and dashboards.

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getAwsAccountId

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

The AWS account ID.

setAwsAccountId

@Stability(Stable)
public void setAwsAccountId(@Nullable
 String value)

The AWS account ID.

getColumnGroups

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

Groupings of columns that work together in certain Amazon QuickSight features.

setColumnGroups

@Stability(Stable)
public void setColumnGroups(@Nullable
 IResolvable value)

Groupings of columns that work together in certain Amazon QuickSight features.

setColumnGroups

@Stability(Stable)
public void setColumnGroups(@Nullable
 List<Object> value)

Groupings of columns that work together in certain Amazon QuickSight features.

getColumnLevelPermissionRules

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

A set of one or more definitions of a ColumnLevelPermissionRule .

setColumnLevelPermissionRules

@Stability(Stable)
public void setColumnLevelPermissionRules(@Nullable
 IResolvable value)

A set of one or more definitions of a ColumnLevelPermissionRule .

setColumnLevelPermissionRules

@Stability(Stable)
public void setColumnLevelPermissionRules(@Nullable
 List<Object> value)

A set of one or more definitions of a ColumnLevelPermissionRule .

getDataSetId

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

An ID for the dataset that you want to create.

setDataSetId

@Stability(Stable)
public void setDataSetId(@Nullable
 String value)

An ID for the dataset that you want to create.

getDatasetParameters

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

The parameters that are declared in a dataset.

setDatasetParameters

@Stability(Stable)
public void setDatasetParameters(@Nullable
 IResolvable value)

The parameters that are declared in a dataset.

setDatasetParameters

@Stability(Stable)
public void setDatasetParameters(@Nullable
 List<Object> value)

The parameters that are declared in a dataset.

getDataSetRefreshProperties

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

The refresh properties of a dataset.

setDataSetRefreshProperties

@Stability(Stable)
public void setDataSetRefreshProperties(@Nullable
 IResolvable value)

The refresh properties of a dataset.

setDataSetRefreshProperties

@Stability(Stable)
public void setDataSetRefreshProperties(@Nullable
 CfnDataSet.DataSetRefreshPropertiesProperty value)

The refresh properties of a dataset.

getDataSetUsageConfiguration

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

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

setDataSetUsageConfiguration

@Stability(Stable)
public void setDataSetUsageConfiguration(@Nullable
 IResolvable value)

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

setDataSetUsageConfiguration

@Stability(Stable)
public void setDataSetUsageConfiguration(@Nullable
 CfnDataSet.DataSetUsageConfigurationProperty value)

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

getFieldFolders

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

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

setFieldFolders

@Stability(Stable)
public void setFieldFolders(@Nullable
 IResolvable value)

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

setFieldFolders

@Stability(Stable)
public void setFieldFolders(@Nullable
 Map<String,Object> value)

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

getFolderArns

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

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

.

setFolderArns

@Stability(Stable)
public void setFolderArns(@Nullable
 List<String> value)

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

.

getImportMode

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

Indicates whether you want to import the data into SPICE.

setImportMode

@Stability(Stable)
public void setImportMode(@Nullable
 String value)

Indicates whether you want to import the data into SPICE.

getIngestionWaitPolicy

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

The wait policy to use when creating or updating a Dataset.

setIngestionWaitPolicy

@Stability(Stable)
public void setIngestionWaitPolicy(@Nullable
 IResolvable value)

The wait policy to use when creating or updating a Dataset.

setIngestionWaitPolicy

@Stability(Stable)
public void setIngestionWaitPolicy(@Nullable
 CfnDataSet.IngestionWaitPolicyProperty value)

The wait policy to use when creating or updating a Dataset.

getLogicalTableMap

@Stability(Stable)
@Nullable
public Object getLogicalTableMap()

Configures the combination and transformation of the data from the physical tables.

setLogicalTableMap

@Stability(Stable)
public void setLogicalTableMap(@Nullable
 IResolvable value)

Configures the combination and transformation of the data from the physical tables.

setLogicalTableMap

@Stability(Stable)
public void setLogicalTableMap(@Nullable
 Map<String,Object> value)

Configures the combination and transformation of the data from the physical tables.

getName

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

The display name for the dataset.

setName

@Stability(Stable)
public void setName(@Nullable
 String value)

The display name for the dataset.

getPerformanceConfiguration

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

The performance optimization configuration of a dataset.

setPerformanceConfiguration

@Stability(Stable)
public void setPerformanceConfiguration(@Nullable
 IResolvable value)

The performance optimization configuration of a dataset.

setPerformanceConfiguration

@Stability(Stable)
public void setPerformanceConfiguration(@Nullable
 CfnDataSet.PerformanceConfigurationProperty value)

The performance optimization configuration of a dataset.

getPermissions

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

A list of resource permissions on the dataset.

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 IResolvable value)

A list of resource permissions on the dataset.

setPermissions

@Stability(Stable)
public void setPermissions(@Nullable
 List<Object> value)

A list of resource permissions on the dataset.

getPhysicalTableMap

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

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

setPhysicalTableMap

@Stability(Stable)
public void setPhysicalTableMap(@Nullable
 IResolvable value)

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

setPhysicalTableMap

@Stability(Stable)
public void setPhysicalTableMap(@Nullable
 Map<String,Object> value)

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

getRowLevelPermissionDataSet

@Stability(Stable)
@Nullable
public Object getRowLevelPermissionDataSet()

The row-level security configuration for the data that you want to create.

setRowLevelPermissionDataSet

@Stability(Stable)
public void setRowLevelPermissionDataSet(@Nullable
 IResolvable value)

The row-level security configuration for the data that you want to create.

setRowLevelPermissionDataSet

@Stability(Stable)
public void setRowLevelPermissionDataSet(@Nullable
 CfnDataSet.RowLevelPermissionDataSetProperty value)

The row-level security configuration for the data that you want to create.

getRowLevelPermissionTagConfiguration

@Stability(Stable)
@Nullable
public Object getRowLevelPermissionTagConfiguration()

The element you can use to define tags for row-level security.

setRowLevelPermissionTagConfiguration

@Stability(Stable)
public void setRowLevelPermissionTagConfiguration(@Nullable
 IResolvable value)

The element you can use to define tags for row-level security.

setRowLevelPermissionTagConfiguration

@Stability(Stable)
public void setRowLevelPermissionTagConfiguration(@Nullable
 CfnDataSet.RowLevelPermissionTagConfigurationProperty value)

The element you can use to define tags for row-level security.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

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

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

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

getUseAs

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

The usage of the dataset.

setUseAs

@Stability(Stable)
public void setUseAs(@Nullable
 String value)

The usage of the dataset.