Package software.amazon.awscdk.services.quicksight

Class CfnDataSetProps.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnDataSetProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSetProps>

Enclosing interface:

CfnDataSetProps

@Stability(Stable)
public static final class CfnDataSetProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDataSetProps>

A builder for CfnDataSetProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDataSetProps.Builder	awsAccountId(String awsAccountId)	Sets the value of CfnDataSetProps.getAwsAccountId()
CfnDataSetProps	build()	Builds the configured instance.
CfnDataSetProps.Builder	columnGroups(List<? extends Object> columnGroups)	Sets the value of CfnDataSetProps.getColumnGroups()
CfnDataSetProps.Builder	columnGroups(IResolvable columnGroups)	Sets the value of CfnDataSetProps.getColumnGroups()
CfnDataSetProps.Builder	columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules)	Sets the value of CfnDataSetProps.getColumnLevelPermissionRules()
CfnDataSetProps.Builder	columnLevelPermissionRules(IResolvable columnLevelPermissionRules)	Sets the value of CfnDataSetProps.getColumnLevelPermissionRules()
CfnDataSetProps.Builder	dataPrepConfiguration(IResolvable dataPrepConfiguration)	Sets the value of CfnDataSetProps.getDataPrepConfiguration()
CfnDataSetProps.Builder	dataPrepConfiguration(CfnDataSet.DataPrepConfigurationProperty dataPrepConfiguration)	Sets the value of CfnDataSetProps.getDataPrepConfiguration()
CfnDataSetProps.Builder	dataSetId(String dataSetId)	Sets the value of CfnDataSetProps.getDataSetId()
CfnDataSetProps.Builder	datasetParameters(List<? extends Object> datasetParameters)	Sets the value of CfnDataSetProps.getDatasetParameters()
CfnDataSetProps.Builder	datasetParameters(IResolvable datasetParameters)	Sets the value of CfnDataSetProps.getDatasetParameters()
CfnDataSetProps.Builder	dataSetRefreshProperties(IResolvable dataSetRefreshProperties)	Sets the value of CfnDataSetProps.getDataSetRefreshProperties()
CfnDataSetProps.Builder	dataSetRefreshProperties(CfnDataSet.DataSetRefreshPropertiesProperty dataSetRefreshProperties)	Sets the value of CfnDataSetProps.getDataSetRefreshProperties()
CfnDataSetProps.Builder	dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration)	Sets the value of CfnDataSetProps.getDataSetUsageConfiguration()
CfnDataSetProps.Builder	dataSetUsageConfiguration(CfnDataSet.DataSetUsageConfigurationProperty dataSetUsageConfiguration)	Sets the value of CfnDataSetProps.getDataSetUsageConfiguration()
CfnDataSetProps.Builder	fieldFolders(Map<String,? extends Object> fieldFolders)	Sets the value of CfnDataSetProps.getFieldFolders()
CfnDataSetProps.Builder	fieldFolders(IResolvable fieldFolders)	Sets the value of CfnDataSetProps.getFieldFolders()
CfnDataSetProps.Builder	folderArns(List<String> folderArns)	Sets the value of CfnDataSetProps.getFolderArns()
CfnDataSetProps.Builder	importMode(String importMode)	Sets the value of CfnDataSetProps.getImportMode()
CfnDataSetProps.Builder	ingestionWaitPolicy(IResolvable ingestionWaitPolicy)	Sets the value of CfnDataSetProps.getIngestionWaitPolicy()
CfnDataSetProps.Builder	ingestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty ingestionWaitPolicy)	Sets the value of CfnDataSetProps.getIngestionWaitPolicy()
CfnDataSetProps.Builder	logicalTableMap(Map<String,? extends Object> logicalTableMap)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	logicalTableMap(IResolvable logicalTableMap)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	name(String name)	Sets the value of CfnDataSetProps.getName()
CfnDataSetProps.Builder	performanceConfiguration(IResolvable performanceConfiguration)	Sets the value of CfnDataSetProps.getPerformanceConfiguration()
CfnDataSetProps.Builder	performanceConfiguration(CfnDataSet.PerformanceConfigurationProperty performanceConfiguration)	Sets the value of CfnDataSetProps.getPerformanceConfiguration()
CfnDataSetProps.Builder	permissions(List<? extends Object> permissions)	Sets the value of CfnDataSetProps.getPermissions()
CfnDataSetProps.Builder	permissions(IResolvable permissions)	Sets the value of CfnDataSetProps.getPermissions()
CfnDataSetProps.Builder	physicalTableMap(Map<String,? extends Object> physicalTableMap)	Sets the value of CfnDataSetProps.getPhysicalTableMap()
CfnDataSetProps.Builder	physicalTableMap(IResolvable physicalTableMap)	Sets the value of CfnDataSetProps.getPhysicalTableMap()
CfnDataSetProps.Builder	rowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	rowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	rowLevelPermissionTagConfiguration(IResolvable rowLevelPermissionTagConfiguration)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	rowLevelPermissionTagConfiguration(CfnDataSet.RowLevelPermissionTagConfigurationProperty rowLevelPermissionTagConfiguration)	Deprecated. this property has been deprecated
CfnDataSetProps.Builder	semanticModelConfiguration(IResolvable semanticModelConfiguration)	Sets the value of CfnDataSetProps.getSemanticModelConfiguration()
CfnDataSetProps.Builder	semanticModelConfiguration(CfnDataSet.SemanticModelConfigurationProperty semanticModelConfiguration)	Sets the value of CfnDataSetProps.getSemanticModelConfiguration()
CfnDataSetProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDataSetProps.getTags()
CfnDataSetProps.Builder	useAs(String useAs)	Sets the value of CfnDataSetProps.getUseAs()

Methods inherited from class java.lang.Object

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

Constructor Details

Builder

public Builder()

Method Details

awsAccountId

@Stability(Stable)
public CfnDataSetProps.Builder awsAccountId(String awsAccountId)

Sets the value of CfnDataSetProps.getAwsAccountId()

Parameters:

awsAccountId - The AWS account ID.

Returns:

this

columnGroups

@Stability(Stable)
public CfnDataSetProps.Builder columnGroups(IResolvable columnGroups)

Sets the value of CfnDataSetProps.getColumnGroups()

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.

Returns:

this

columnGroups

@Stability(Stable)
public CfnDataSetProps.Builder columnGroups(List<? extends Object> columnGroups)

Sets the value of CfnDataSetProps.getColumnGroups()

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon Quick Sight features. Currently, only geospatial hierarchy is supported.

Returns:

this

columnLevelPermissionRules

@Stability(Stable)
public CfnDataSetProps.Builder columnLevelPermissionRules(IResolvable columnLevelPermissionRules)

Sets the value of CfnDataSetProps.getColumnLevelPermissionRules()

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

Returns:

this

columnLevelPermissionRules

@Stability(Stable)
public CfnDataSetProps.Builder columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules)

Sets the value of CfnDataSetProps.getColumnLevelPermissionRules()

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a ColumnLevelPermissionRule .

Returns:

this

dataPrepConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder dataPrepConfiguration(IResolvable dataPrepConfiguration)

Sets the value of CfnDataSetProps.getDataPrepConfiguration()

Parameters:

dataPrepConfiguration - The data preparation configuration associated with this dataset.

Returns:

this

dataPrepConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder dataPrepConfiguration(CfnDataSet.DataPrepConfigurationProperty dataPrepConfiguration)

Sets the value of CfnDataSetProps.getDataPrepConfiguration()

Parameters:

dataPrepConfiguration - The data preparation configuration associated with this dataset.

Returns:

this

dataSetId

@Stability(Stable)
public CfnDataSetProps.Builder dataSetId(String dataSetId)

Sets the value of CfnDataSetProps.getDataSetId()

Parameters:

dataSetId - An ID for the dataset that you want to create. This ID is unique per AWS Region for each AWS account.

Returns:

this

datasetParameters

@Stability(Stable)
public CfnDataSetProps.Builder datasetParameters(IResolvable datasetParameters)

Sets the value of CfnDataSetProps.getDatasetParameters()

Parameters:

datasetParameters - The parameters that are declared in a dataset.

Returns:

this

datasetParameters

@Stability(Stable)
public CfnDataSetProps.Builder datasetParameters(List<? extends Object> datasetParameters)

Sets the value of CfnDataSetProps.getDatasetParameters()

Parameters:

datasetParameters - The parameters that are declared in a dataset.

Returns:

this

dataSetRefreshProperties

@Stability(Stable)
public CfnDataSetProps.Builder dataSetRefreshProperties(IResolvable dataSetRefreshProperties)

Sets the value of CfnDataSetProps.getDataSetRefreshProperties()

Parameters:

dataSetRefreshProperties - The refresh properties of a dataset.

Returns:

this

dataSetRefreshProperties

@Stability(Stable)
public CfnDataSetProps.Builder dataSetRefreshProperties(CfnDataSet.DataSetRefreshPropertiesProperty dataSetRefreshProperties)

Sets the value of CfnDataSetProps.getDataSetRefreshProperties()

Parameters:

dataSetRefreshProperties - The refresh properties of a dataset.

Returns:

this

dataSetUsageConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration)

Sets the value of CfnDataSetProps.getDataSetUsageConfiguration()

Parameters:

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

Returns:

this

dataSetUsageConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder dataSetUsageConfiguration(CfnDataSet.DataSetUsageConfigurationProperty dataSetUsageConfiguration)

Sets the value of CfnDataSetProps.getDataSetUsageConfiguration()

Parameters:

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

Returns:

this

fieldFolders

@Stability(Stable)
public CfnDataSetProps.Builder fieldFolders(IResolvable fieldFolders)

Sets the value of CfnDataSetProps.getFieldFolders()

Parameters:

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

Returns:

this

fieldFolders

@Stability(Stable)
public CfnDataSetProps.Builder fieldFolders(Map<String,? extends Object> fieldFolders)

Sets the value of CfnDataSetProps.getFieldFolders()

Parameters:

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

Returns:

this

folderArns

@Stability(Stable)
public CfnDataSetProps.Builder folderArns(List<String> folderArns)

Sets the value of CfnDataSetProps.getFolderArns()

Parameters:

folderArns -

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

.

Returns:

this

importMode

@Stability(Stable)
public CfnDataSetProps.Builder importMode(String importMode)

Sets the value of CfnDataSetProps.getImportMode()

Parameters:

importMode - Indicates whether you want to import the data into SPICE.

Returns:

this

ingestionWaitPolicy

@Stability(Stable)
public CfnDataSetProps.Builder ingestionWaitPolicy(IResolvable ingestionWaitPolicy)

Sets the value of CfnDataSetProps.getIngestionWaitPolicy()

Parameters:

ingestionWaitPolicy - 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:

this

ingestionWaitPolicy

@Stability(Stable)
public CfnDataSetProps.Builder ingestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty ingestionWaitPolicy)

Sets the value of CfnDataSetProps.getIngestionWaitPolicy()

Parameters:

ingestionWaitPolicy - 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:

this

logicalTableMap

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder logicalTableMap(IResolvable logicalTableMap)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getLogicalTableMap()

Parameters:

logicalTableMap - the value to be set.

Returns:

this

logicalTableMap

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder logicalTableMap(Map<String,? extends Object> logicalTableMap)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getLogicalTableMap()

Parameters:

logicalTableMap - the value to be set.

Returns:

this

name

@Stability(Stable)
public CfnDataSetProps.Builder name(String name)

Sets the value of CfnDataSetProps.getName()

Parameters:

name - The display name for the dataset.

Returns:

this

performanceConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder performanceConfiguration(IResolvable performanceConfiguration)

Sets the value of CfnDataSetProps.getPerformanceConfiguration()

Parameters:

performanceConfiguration - The performance optimization configuration of a dataset.

Returns:

this

performanceConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder performanceConfiguration(CfnDataSet.PerformanceConfigurationProperty performanceConfiguration)

Sets the value of CfnDataSetProps.getPerformanceConfiguration()

Parameters:

performanceConfiguration - The performance optimization configuration of a dataset.

Returns:

this

permissions

@Stability(Stable)
public CfnDataSetProps.Builder permissions(IResolvable permissions)

Sets the value of CfnDataSetProps.getPermissions()

Parameters:

permissions - A list of resource permissions on the dataset.

Returns:

this

permissions

@Stability(Stable)
public CfnDataSetProps.Builder permissions(List<? extends Object> permissions)

Sets the value of CfnDataSetProps.getPermissions()

Parameters:

permissions - A list of resource permissions on the dataset.

Returns:

this

physicalTableMap

@Stability(Stable)
public CfnDataSetProps.Builder physicalTableMap(IResolvable physicalTableMap)

Sets the value of CfnDataSetProps.getPhysicalTableMap()

Parameters:

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

Returns:

this

physicalTableMap

@Stability(Stable)
public CfnDataSetProps.Builder physicalTableMap(Map<String,? extends Object> physicalTableMap)

Sets the value of CfnDataSetProps.getPhysicalTableMap()

Parameters:

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

Returns:

this

rowLevelPermissionDataSet

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder rowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getRowLevelPermissionDataSet()

Parameters:

rowLevelPermissionDataSet -

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:

this

rowLevelPermissionDataSet

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder rowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getRowLevelPermissionDataSet()

Parameters:

rowLevelPermissionDataSet -

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:

this

rowLevelPermissionTagConfiguration

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder rowLevelPermissionTagConfiguration(IResolvable rowLevelPermissionTagConfiguration)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getRowLevelPermissionTagConfiguration()

Parameters:

rowLevelPermissionTagConfiguration -

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

Returns:

this

rowLevelPermissionTagConfiguration

@Stability(Deprecated)
@Deprecated
public CfnDataSetProps.Builder rowLevelPermissionTagConfiguration(CfnDataSet.RowLevelPermissionTagConfigurationProperty rowLevelPermissionTagConfiguration)

Deprecated.

this property has been deprecated

Sets the value of CfnDataSetProps.getRowLevelPermissionTagConfiguration()

Parameters:

rowLevelPermissionTagConfiguration -

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

Returns:

this

semanticModelConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder semanticModelConfiguration(IResolvable semanticModelConfiguration)

Sets the value of CfnDataSetProps.getSemanticModelConfiguration()

Parameters:

semanticModelConfiguration - The semantic model configuration associated with this dataset.

Returns:

this

semanticModelConfiguration

@Stability(Stable)
public CfnDataSetProps.Builder semanticModelConfiguration(CfnDataSet.SemanticModelConfigurationProperty semanticModelConfiguration)

Sets the value of CfnDataSetProps.getSemanticModelConfiguration()

Parameters:

semanticModelConfiguration - The semantic model configuration associated with this dataset.

Returns:

this

tags

@Stability(Stable)
public CfnDataSetProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDataSetProps.getTags()

Parameters:

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

Returns:

this

useAs

@Stability(Stable)
public CfnDataSetProps.Builder useAs(String useAs)

Sets the value of CfnDataSetProps.getUseAs()

Parameters:

useAs - The usage of the dataset.

Returns:

this

build

@Stability(Stable)
public CfnDataSetProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDataSetProps>

Returns:

a new instance of CfnDataSetProps

Throws:

NullPointerException - if any required attribute was not provided