Class CfnDataSetPropsMixin.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDataSetPropsMixin>
- Enclosing class:
CfnDataSetPropsMixin
CfnDataSetPropsMixin.-
Method Summary
Modifier and TypeMethodDescriptionawsAccountId(String awsAccountId) The AWS account ID.build()columnGroups(List<? extends Object> columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.columnGroups(IResolvable columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.columnLevelPermissionRules(IResolvable columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.static CfnDataSetPropsMixin.Buildercreate()static CfnDataSetPropsMixin.Buildercreate(CfnPropertyMixinOptions options) dataPrepConfiguration(CfnDataSetPropsMixin.DataPrepConfigurationProperty dataPrepConfiguration) The data preparation configuration associated with this dataset.dataPrepConfiguration(IResolvable dataPrepConfiguration) The data preparation configuration associated with this dataset.An ID for the dataset that you want to create.datasetParameters(List<? extends Object> datasetParameters) The parameters that are declared in a dataset.datasetParameters(IResolvable datasetParameters) The parameters that are declared in a dataset.dataSetRefreshProperties(CfnDataSetPropsMixin.DataSetRefreshPropertiesProperty dataSetRefreshProperties) The refresh properties of a dataset.dataSetRefreshProperties(IResolvable dataSetRefreshProperties) The refresh properties of a dataset.dataSetUsageConfiguration(CfnDataSetPropsMixin.DataSetUsageConfigurationProperty dataSetUsageConfiguration) The usage configuration to apply to child datasets that reference this dataset as a source.dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration) The usage configuration to apply to child datasets that reference this dataset as a source.fieldFolders(Map<String, ? extends Object> fieldFolders) The folder that contains fields and nested subfolders for your dataset.fieldFolders(IResolvable fieldFolders) The folder that contains fields and nested subfolders for your dataset.folderArns(List<String> folderArns) When you create the dataset, Quick Suite adds the dataset to these folders.importMode(String importMode) Indicates whether you want to import the data into SPICE.ingestionWaitPolicy(CfnDataSetPropsMixin.IngestionWaitPolicyProperty ingestionWaitPolicy) The wait policy to use when creating or updating a Dataset.ingestionWaitPolicy(IResolvable ingestionWaitPolicy) The wait policy to use when creating or updating a Dataset.logicalTableMap(Map<String, ? extends Object> logicalTableMap) Deprecated.this property has been deprecatedlogicalTableMap(IResolvable logicalTableMap) Deprecated.this property has been deprecatedThe display name for the dataset.performanceConfiguration(CfnDataSetPropsMixin.PerformanceConfigurationProperty performanceConfiguration) The performance optimization configuration of a dataset.performanceConfiguration(IResolvable performanceConfiguration) The performance optimization configuration of a dataset.permissions(List<? extends Object> permissions) A list of resource permissions on the dataset.permissions(IResolvable permissions) A list of resource permissions on the dataset.physicalTableMap(Map<String, ? extends Object> physicalTableMap) Declares the physical tables that are available in the underlying data sources.physicalTableMap(IResolvable physicalTableMap) Declares the physical tables that are available in the underlying data sources.rowLevelPermissionDataSet(CfnDataSetPropsMixin.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet) Deprecated.this property has been deprecatedrowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet) Deprecated.this property has been deprecatedrowLevelPermissionTagConfiguration(CfnDataSetPropsMixin.RowLevelPermissionTagConfigurationProperty rowLevelPermissionTagConfiguration) Deprecated.this property has been deprecatedrowLevelPermissionTagConfiguration(IResolvable rowLevelPermissionTagConfiguration) Deprecated.this property has been deprecatedsemanticModelConfiguration(CfnDataSetPropsMixin.SemanticModelConfigurationProperty semanticModelConfiguration) The semantic model configuration associated with this dataset.semanticModelConfiguration(IResolvable semanticModelConfiguration) The semantic model configuration associated with this dataset.Contains a map of the key-value pairs for the resource tag or tags assigned to the dataset.The usage of the dataset.
-
Method Details
-
create
@Stability(Stable) public static CfnDataSetPropsMixin.Builder create(CfnPropertyMixinOptions options) - Parameters:
options- Mixin options.- Returns:
- a new instance of
CfnDataSetPropsMixin.Builder.
-
create
- Returns:
- a new instance of
CfnDataSetPropsMixin.Builder.
-
awsAccountId
The AWS account ID.- Parameters:
awsAccountId- The AWS account ID. This parameter is required.- Returns:
this- See Also:
-
columnGroups
Groupings of columns that work together in certain Amazon Quick Sight features.Currently, only geospatial hierarchy is supported.
- Parameters:
columnGroups- Groupings of columns that work together in certain Amazon Quick Sight features. This parameter is required.- Returns:
this- See Also:
-
columnGroups
@Stability(Stable) public CfnDataSetPropsMixin.Builder columnGroups(List<? extends Object> columnGroups) Groupings of columns that work together in certain Amazon Quick Sight features.Currently, only geospatial hierarchy is supported.
- Parameters:
columnGroups- Groupings of columns that work together in certain Amazon Quick Sight features. This parameter is required.- Returns:
this- See Also:
-
columnLevelPermissionRules
@Stability(Stable) public CfnDataSetPropsMixin.Builder columnLevelPermissionRules(IResolvable columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.- Parameters:
columnLevelPermissionRules- A set of one or more definitions of aColumnLevelPermissionRule. This parameter is required.- Returns:
this- See Also:
-
columnLevelPermissionRules
@Stability(Stable) public CfnDataSetPropsMixin.Builder columnLevelPermissionRules(List<? extends Object> columnLevelPermissionRules) A set of one or more definitions of aColumnLevelPermissionRule.- Parameters:
columnLevelPermissionRules- A set of one or more definitions of aColumnLevelPermissionRule. This parameter is required.- Returns:
this- See Also:
-
dataPrepConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataPrepConfiguration(IResolvable dataPrepConfiguration) The data preparation configuration associated with this dataset.- Parameters:
dataPrepConfiguration- The data preparation configuration associated with this dataset. This parameter is required.- Returns:
this- See Also:
-
dataPrepConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataPrepConfiguration(CfnDataSetPropsMixin.DataPrepConfigurationProperty dataPrepConfiguration) The data preparation configuration associated with this dataset.- Parameters:
dataPrepConfiguration- The data preparation configuration associated with this dataset. This parameter is required.- Returns:
this- See Also:
-
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- See Also:
-
datasetParameters
@Stability(Stable) public CfnDataSetPropsMixin.Builder datasetParameters(IResolvable datasetParameters) The parameters that are declared in a dataset.- Parameters:
datasetParameters- The parameters that are declared in a dataset. This parameter is required.- Returns:
this- See Also:
-
datasetParameters
@Stability(Stable) public CfnDataSetPropsMixin.Builder datasetParameters(List<? extends Object> datasetParameters) The parameters that are declared in a dataset.- Parameters:
datasetParameters- The parameters that are declared in a dataset. This parameter is required.- Returns:
this- See Also:
-
dataSetRefreshProperties
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataSetRefreshProperties(IResolvable dataSetRefreshProperties) The refresh properties of a dataset.- Parameters:
dataSetRefreshProperties- The refresh properties of a dataset. This parameter is required.- Returns:
this- See Also:
-
dataSetRefreshProperties
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataSetRefreshProperties(CfnDataSetPropsMixin.DataSetRefreshPropertiesProperty dataSetRefreshProperties) The refresh properties of a dataset.- Parameters:
dataSetRefreshProperties- The refresh properties of a dataset. This parameter is required.- Returns:
this- See Also:
-
dataSetUsageConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataSetUsageConfiguration(IResolvable dataSetUsageConfiguration) The usage configuration to apply to child datasets that reference this dataset as a source.- Parameters:
dataSetUsageConfiguration- The usage configuration to apply to child datasets that reference this dataset as a source. This parameter is required.- Returns:
this- See Also:
-
dataSetUsageConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder dataSetUsageConfiguration(CfnDataSetPropsMixin.DataSetUsageConfigurationProperty dataSetUsageConfiguration) The usage configuration to apply to child datasets that reference this dataset as a source.- Parameters:
dataSetUsageConfiguration- The usage configuration to apply to child datasets that reference this dataset as a source. This parameter is required.- Returns:
this- See Also:
-
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- See Also:
-
fieldFolders
@Stability(Stable) public CfnDataSetPropsMixin.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- See Also:
-
folderArns
When you create the dataset, Quick Suite adds the dataset to these folders.
.- Parameters:
folderArns-When you create the dataset, Quick Suite adds the dataset to these folders.
. This parameter is required.- Returns:
this- See Also:
-
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- See Also:
-
ingestionWaitPolicy
@Stability(Stable) public CfnDataSetPropsMixin.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- See Also:
-
ingestionWaitPolicy
@Stability(Stable) public CfnDataSetPropsMixin.Builder ingestionWaitPolicy(CfnDataSetPropsMixin.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- See Also:
-
logicalTableMap
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder logicalTableMap(IResolvable logicalTableMap) Deprecated.this property has been deprecated- Parameters:
logicalTableMap- This parameter is required.- Returns:
this- See Also:
-
logicalTableMap
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder logicalTableMap(Map<String, ? extends Object> logicalTableMap) Deprecated.this property has been deprecated- Parameters:
logicalTableMap- This parameter is required.- Returns:
this- See Also:
-
name
The display name for the dataset.- Parameters:
name- The display name for the dataset. This parameter is required.- Returns:
this- See Also:
-
performanceConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder performanceConfiguration(IResolvable performanceConfiguration) The performance optimization configuration of a dataset.- Parameters:
performanceConfiguration- The performance optimization configuration of a dataset. This parameter is required.- Returns:
this- See Also:
-
performanceConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder performanceConfiguration(CfnDataSetPropsMixin.PerformanceConfigurationProperty performanceConfiguration) The performance optimization configuration of a dataset.- Parameters:
performanceConfiguration- The performance optimization configuration of a dataset. This parameter is required.- Returns:
this- See Also:
-
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- See Also:
-
permissions
@Stability(Stable) public CfnDataSetPropsMixin.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- See Also:
-
physicalTableMap
@Stability(Stable) public CfnDataSetPropsMixin.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- See Also:
-
physicalTableMap
@Stability(Stable) public CfnDataSetPropsMixin.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- See Also:
-
rowLevelPermissionDataSet
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder rowLevelPermissionDataSet(IResolvable rowLevelPermissionDataSet) 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 Quick Suite User Guide.
The option to deny permissions by setting
PermissionPolicytoDENY_ACCESSis not supported for new RLS datasets.- Parameters:
rowLevelPermissionDataSet-Information about a dataset that contains permissions for row-level security (RLS). This parameter is required.
- Returns:
this- See Also:
-
rowLevelPermissionDataSet
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder rowLevelPermissionDataSet(CfnDataSetPropsMixin.RowLevelPermissionDataSetProperty rowLevelPermissionDataSet) 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 Quick Suite User Guide.
The option to deny permissions by setting
PermissionPolicytoDENY_ACCESSis not supported for new RLS datasets.- Parameters:
rowLevelPermissionDataSet-Information about a dataset that contains permissions for row-level security (RLS). This parameter is required.
- Returns:
this- See Also:
-
rowLevelPermissionTagConfiguration
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder rowLevelPermissionTagConfiguration(IResolvable rowLevelPermissionTagConfiguration) Deprecated.this property has been deprecated(deprecated)The configuration of tags on a dataset to set row-level security.
- Parameters:
rowLevelPermissionTagConfiguration-The configuration of tags on a dataset to set row-level security. This parameter is required.
- Returns:
this- See Also:
-
rowLevelPermissionTagConfiguration
@Stability(Deprecated) @Deprecated public CfnDataSetPropsMixin.Builder rowLevelPermissionTagConfiguration(CfnDataSetPropsMixin.RowLevelPermissionTagConfigurationProperty rowLevelPermissionTagConfiguration) Deprecated.this property has been deprecated(deprecated)The configuration of tags on a dataset to set row-level security.
- Parameters:
rowLevelPermissionTagConfiguration-The configuration of tags on a dataset to set row-level security. This parameter is required.
- Returns:
this- See Also:
-
semanticModelConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder semanticModelConfiguration(IResolvable semanticModelConfiguration) The semantic model configuration associated with this dataset.- Parameters:
semanticModelConfiguration- The semantic model configuration associated with this dataset. This parameter is required.- Returns:
this- See Also:
-
semanticModelConfiguration
@Stability(Stable) public CfnDataSetPropsMixin.Builder semanticModelConfiguration(CfnDataSetPropsMixin.SemanticModelConfigurationProperty semanticModelConfiguration) The semantic model configuration associated with this dataset.- Parameters:
semanticModelConfiguration- The semantic model configuration associated with this dataset. This parameter is required.- Returns:
this- See Also:
-
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- See Also:
-
useAs
The usage of the dataset.- Parameters:
useAs- The usage of the dataset. This parameter is required.- Returns:
this- See Also:
-
build
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnDataSetPropsMixin>- Returns:
- a newly built instance of
CfnDataSetPropsMixin.
-