software.amazon.awscdk.services.quicksight

Class CfnDataSet.Builder

java.lang.Object

software.amazon.awscdk.services.quicksight.CfnDataSet.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDataSet>

Enclosing class:

CfnDataSet

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

A fluent builder for CfnDataSet.

Method Summary

Modifier and Type	Method and Description
CfnDataSet.Builder	awsAccountId(String awsAccountId) The AWS account ID.
CfnDataSet	build()
CfnDataSet.Builder	columnGroups(IResolvable columnGroups) Groupings of columns that work together in certain Amazon QuickSight features.
CfnDataSet.Builder	columnGroups(List<? extends Object> columnGroups) Groupings of columns that work together in certain Amazon QuickSight features.
CfnDataSet.Builder	columnLevelPermissionRules(IResolvable columnLevelPermissionRules) A set of one or more definitions of a `ColumnLevelPermissionRule` .
CfnDataSet.Builder	columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules) A set of one or more definitions of a `ColumnLevelPermissionRule` .
static CfnDataSet.Builder	create(Construct scope, String id)
CfnDataSet.Builder	dataSetId(String dataSetId) An ID for the dataset that you want to create.
CfnDataSet.Builder	dataSetUsageConfiguration(CfnDataSet.DataSetUsageConfigurationProperty dataSetUsageConfiguration) `AWS::QuickSight::DataSet.DataSetUsageConfiguration`.
CfnDataSet.Builder	dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration) `AWS::QuickSight::DataSet.DataSetUsageConfiguration`.
CfnDataSet.Builder	fieldFolders(IResolvable fieldFolders) The folder that contains fields and nested subfolders for your dataset.
CfnDataSet.Builder	fieldFolders(Map<String,? extends Object> fieldFolders) The folder that contains fields and nested subfolders for your dataset.
CfnDataSet.Builder	importMode(String importMode) Indicates whether you want to import the data into SPICE.
CfnDataSet.Builder	ingestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty ingestionWaitPolicy) The wait policy to use when creating or updating a Dataset.
CfnDataSet.Builder	ingestionWaitPolicy(IResolvable ingestionWaitPolicy) The wait policy to use when creating or updating a Dataset.
CfnDataSet.Builder	logicalTableMap(IResolvable logicalTableMap) Configures the combination and transformation of the data from the physical tables.
CfnDataSet.Builder	logicalTableMap(Map<String,? extends Object> logicalTableMap) Configures the combination and transformation of the data from the physical tables.
CfnDataSet.Builder	name(String name) The display name for the dataset.
CfnDataSet.Builder	permissions(IResolvable permissions) A list of resource permissions on the dataset.
CfnDataSet.Builder	permissions(List<? extends Object> permissions) A list of resource permissions on the dataset.
CfnDataSet.Builder	physicalTableMap(IResolvable physicalTableMap) Declares the physical tables that are available in the underlying data sources.
CfnDataSet.Builder	physicalTableMap(Map<String,? extends Object> physicalTableMap) Declares the physical tables that are available in the underlying data sources.
CfnDataSet.Builder	rowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet) The row-level security configuration for the data that you want to create.
CfnDataSet.Builder	rowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet) The row-level security configuration for the data that you want to create.
CfnDataSet.Builder	tags(List<? extends CfnTag> tags) Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.

Methods inherited from class java.lang.Object

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

Method Detail

create

@Stability(value=Stable)
public static CfnDataSet.Builder create(Construct scope,
                                                                 String id)

Parameters:

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

id - - scoped id of the resource. This parameter is required.

Returns:

a new instance of CfnDataSet.CalculatedColumnProperty.Builder.

awsAccountId

@Stability(value=Stable)
public CfnDataSet.Builder awsAccountId(String awsAccountId)

The AWS account ID.

Parameters:

awsAccountId - The AWS account ID. This parameter is required.

Returns:

this

columnGroups

@Stability(value=Stable)
public CfnDataSet.Builder columnGroups(IResolvable columnGroups)

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

Currently, only geospatial hierarchy is supported.

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon QuickSight features. This parameter is required.

Returns:

this

columnGroups

@Stability(value=Stable)
public CfnDataSet.Builder columnGroups(List<? extends Object> columnGroups)

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

Currently, only geospatial hierarchy is supported.

Parameters:

columnGroups - Groupings of columns that work together in certain Amazon QuickSight features. This parameter is required.

Returns:

this

columnLevelPermissionRules

@Stability(value=Stable)
public CfnDataSet.Builder columnLevelPermissionRules(IResolvable columnLevelPermissionRules)

A set of one or more definitions of a `ColumnLevelPermissionRule` .

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a `ColumnLevelPermissionRule` . This parameter is required.

Returns:

this

columnLevelPermissionRules

@Stability(value=Stable)
public CfnDataSet.Builder columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules)

A set of one or more definitions of a `ColumnLevelPermissionRule` .

Parameters:

columnLevelPermissionRules - A set of one or more definitions of a `ColumnLevelPermissionRule` . This parameter is required.

Returns:

this

dataSetId

@Stability(value=Stable)
public CfnDataSet.Builder dataSetId(String dataSetId)

An ID for the dataset that you want to create.

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

Parameters:

dataSetId - An ID for the dataset that you want to create. This parameter is required.

Returns:

this

dataSetUsageConfiguration

@Stability(value=Stable)
public CfnDataSet.Builder dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration)

`AWS::QuickSight::DataSet.DataSetUsageConfiguration`.

Parameters:

dataSetUsageConfiguration - `AWS::QuickSight::DataSet.DataSetUsageConfiguration`. This parameter is required.

Returns:

this

dataSetUsageConfiguration

@Stability(value=Stable)
public CfnDataSet.Builder dataSetUsageConfiguration(CfnDataSet.DataSetUsageConfigurationProperty dataSetUsageConfiguration)

`AWS::QuickSight::DataSet.DataSetUsageConfiguration`.

Parameters:

dataSetUsageConfiguration - `AWS::QuickSight::DataSet.DataSetUsageConfiguration`. This parameter is required.

Returns:

this

fieldFolders

@Stability(value=Stable)
public CfnDataSet.Builder fieldFolders(IResolvable fieldFolders)

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

Parameters:

fieldFolders - The folder that contains fields and nested subfolders for your dataset. This parameter is required.

Returns:

this

fieldFolders

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

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

Parameters:

fieldFolders - The folder that contains fields and nested subfolders for your dataset. This parameter is required.

Returns:

this

importMode

@Stability(value=Stable)
public CfnDataSet.Builder importMode(String importMode)

Indicates whether you want to import the data into SPICE.

Parameters:

importMode - Indicates whether you want to import the data into SPICE. This parameter is required.

Returns:

this

ingestionWaitPolicy

@Stability(value=Stable)
public CfnDataSet.Builder ingestionWaitPolicy(IResolvable 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.

Parameters:

ingestionWaitPolicy - The wait policy to use when creating or updating a Dataset. This parameter is required.

Returns:

this

ingestionWaitPolicy

@Stability(value=Stable)
public CfnDataSet.Builder ingestionWaitPolicy(CfnDataSet.IngestionWaitPolicyProperty 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.

Parameters:

ingestionWaitPolicy - The wait policy to use when creating or updating a Dataset. This parameter is required.

Returns:

this

logicalTableMap

@Stability(value=Stable)
public CfnDataSet.Builder logicalTableMap(IResolvable logicalTableMap)

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

Parameters:

logicalTableMap - Configures the combination and transformation of the data from the physical tables. This parameter is required.

Returns:

this

logicalTableMap

@Stability(value=Stable)
public CfnDataSet.Builder logicalTableMap(Map<String,? extends Object> logicalTableMap)

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

Parameters:

logicalTableMap - Configures the combination and transformation of the data from the physical tables. This parameter is required.

Returns:

this

name

@Stability(value=Stable)
public CfnDataSet.Builder name(String name)

The display name for the dataset.

Parameters:

name - The display name for the dataset. This parameter is required.

Returns:

this

permissions

@Stability(value=Stable)
public CfnDataSet.Builder permissions(IResolvable permissions)

A list of resource permissions on the dataset.

Parameters:

permissions - A list of resource permissions on the dataset. This parameter is required.

Returns:

this

permissions

@Stability(value=Stable)
public CfnDataSet.Builder permissions(List<? extends Object> permissions)

A list of resource permissions on the dataset.

Parameters:

permissions - A list of resource permissions on the dataset. This parameter is required.

Returns:

this

physicalTableMap

@Stability(value=Stable)
public CfnDataSet.Builder physicalTableMap(IResolvable physicalTableMap)

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

Parameters:

physicalTableMap - Declares the physical tables that are available in the underlying data sources. This parameter is required.

Returns:

this

physicalTableMap

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

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

Parameters:

physicalTableMap - Declares the physical tables that are available in the underlying data sources. This parameter is required.

Returns:

this

rowLevelPermissionDataSet

@Stability(value=Stable)
public CfnDataSet.Builder rowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet)

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

Parameters:

rowLevelPermissionDataSet - The row-level security configuration for the data that you want to create. This parameter is required.

Returns:

this

rowLevelPermissionDataSet

@Stability(value=Stable)
public CfnDataSet.Builder rowLevelPermissionDataSet(CfnDataSet.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet)

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

Parameters:

rowLevelPermissionDataSet - The row-level security configuration for the data that you want to create. This parameter is required.

Returns:

this

tags

@Stability(value=Stable)
public CfnDataSet.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

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

Returns:

this

build

@Stability(value=Stable)
public CfnDataSet build()

Specified by:

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