Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.DataPrepConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.DataPrepConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.DataPrepConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Configuration for data preparation operations, defining the complete pipeline from source tables through transformations to destination tables.

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.*;
 DataPrepConfigurationProperty dataPrepConfigurationProperty = DataPrepConfigurationProperty.builder()
         .destinationTableMap(Map.of(
                 "destinationTableMapKey", DestinationTableProperty.builder()
                         .alias("alias")
                         .source(DestinationTableSourceProperty.builder()
                                 .transformOperationId("transformOperationId")
                                 .build())
                         .build()))
         .sourceTableMap(Map.of(
                 "sourceTableMapKey", SourceTableProperty.builder()
                         .dataSet(ParentDataSetProperty.builder()
                                 .dataSetArn("dataSetArn")
                                 .inputColumns(List.of(InputColumnProperty.builder()
                                         .name("name")
                                         .type("type")
                                         // the properties below are optional
                                         .id("id")
                                         .subType("subType")
                                         .build()))
                                 .build())
                         .physicalTableId("physicalTableId")
                         .build()))
         .transformStepMap(Map.of(
                 "transformStepMapKey", TransformStepProperty.builder()
                         .aggregateStep(AggregateOperationProperty.builder()
                                 .aggregations(List.of(AggregationProperty.builder()
                                         .aggregationFunction(DataPrepAggregationFunctionProperty.builder()
                                                 .listAggregation(DataPrepListAggregationFunctionProperty.builder()
                                                         .distinct(false)
                                                         .separator("separator")
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .percentileAggregation(DataPrepPercentileAggregationFunctionProperty.builder()
                                                         .percentileValue(123)
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .simpleAggregation(DataPrepSimpleAggregationFunctionProperty.builder()
                                                         .functionType("functionType")
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .build())
                                         .newColumnId("newColumnId")
                                         .newColumnName("newColumnName")
                                         .build()))
                                 .alias("alias")
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 // the properties below are optional
                                 .groupByColumnNames(List.of("groupByColumnNames"))
                                 .build())
                         .appendStep(AppendOperationProperty.builder()
                                 .alias("alias")
                                 .appendedColumns(List.of(AppendedColumnProperty.builder()
                                         .columnName("columnName")
                                         .newColumnId("newColumnId")
                                         .build()))
                                 // the properties below are optional
                                 .firstSource(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .secondSource(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .castColumnTypesStep(CastColumnTypesOperationProperty.builder()
                                 .alias("alias")
                                 .castColumnTypeOperations(List.of(CastColumnTypeOperationProperty.builder()
                                         .columnName("columnName")
                                         .newColumnType("newColumnType")
                                         // the properties below are optional
                                         .format("format")
                                         .subType("subType")
                                         .build()))
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .createColumnsStep(CreateColumnsOperationProperty.builder()
                                 .columns(List.of(CalculatedColumnProperty.builder()
                                         .columnId("columnId")
                                         .columnName("columnName")
                                         .expression("expression")
                                         .build()))
                                 // the properties below are optional
                                 .alias("alias")
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .filtersStep(FiltersOperationProperty.builder()
                                 .alias("alias")
                                 .filterOperations(List.of(FilterOperationProperty.builder()
                                         .conditionExpression("conditionExpression")
                                         .dateFilterCondition(DataSetDateFilterConditionProperty.builder()
                                                 .columnName("columnName")
                                                 .comparisonFilterCondition(DataSetDateComparisonFilterConditionProperty.builder()
                                                         .operator("operator")
                                                         // the properties below are optional
                                                         .value(DataSetDateFilterValueProperty.builder()
                                                                 .staticValue("staticValue")
                                                                 .build())
                                                         .build())
                                                 .rangeFilterCondition(DataSetDateRangeFilterConditionProperty.builder()
                                                         .includeMaximum(false)
                                                         .includeMinimum(false)
                                                         .rangeMaximum(DataSetDateFilterValueProperty.builder()
                                                                 .staticValue("staticValue")
                                                                 .build())
                                                         .rangeMinimum(DataSetDateFilterValueProperty.builder()
                                                                 .staticValue("staticValue")
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .numericFilterCondition(DataSetNumericFilterConditionProperty.builder()
                                                 .columnName("columnName")
                                                 .comparisonFilterCondition(DataSetNumericComparisonFilterConditionProperty.builder()
                                                         .operator("operator")
                                                         // the properties below are optional
                                                         .value(DataSetNumericFilterValueProperty.builder()
                                                                 .staticValue(123)
                                                                 .build())
                                                         .build())
                                                 .rangeFilterCondition(DataSetNumericRangeFilterConditionProperty.builder()
                                                         .includeMaximum(false)
                                                         .includeMinimum(false)
                                                         .rangeMaximum(DataSetNumericFilterValueProperty.builder()
                                                                 .staticValue(123)
                                                                 .build())
                                                         .rangeMinimum(DataSetNumericFilterValueProperty.builder()
                                                                 .staticValue(123)
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .stringFilterCondition(DataSetStringFilterConditionProperty.builder()
                                                 .columnName("columnName")
                                                 .comparisonFilterCondition(DataSetStringComparisonFilterConditionProperty.builder()
                                                         .operator("operator")
                                                         // the properties below are optional
                                                         .value(DataSetStringFilterValueProperty.builder()
                                                                 .staticValue("staticValue")
                                                                 .build())
                                                         .build())
                                                 .listFilterCondition(DataSetStringListFilterConditionProperty.builder()
                                                         .operator("operator")
                                                         // the properties below are optional
                                                         .values(DataSetStringListFilterValueProperty.builder()
                                                                 .staticValues(List.of("staticValues"))
                                                                 .build())
                                                         .build())
                                                 .build())
                                         .build()))
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .importTableStep(ImportTableOperationProperty.builder()
                                 .alias("alias")
                                 .source(ImportTableOperationSourceProperty.builder()
                                         .sourceTableId("sourceTableId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .joinStep(JoinOperationProperty.builder()
                                 .alias("alias")
                                 .leftOperand(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .onClause("onClause")
                                 .rightOperand(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .type("type")
                                 // the properties below are optional
                                 .leftOperandProperties(JoinOperandPropertiesProperty.builder()
                                         .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                                                 .outputColumnName("outputColumnName")
                                                 // the properties below are optional
                                                 .sourceColumnName("sourceColumnName")
                                                 .build()))
                                         .build())
                                 .rightOperandProperties(JoinOperandPropertiesProperty.builder()
                                         .outputColumnNameOverrides(List.of(OutputColumnNameOverrideProperty.builder()
                                                 .outputColumnName("outputColumnName")
                                                 // the properties below are optional
                                                 .sourceColumnName("sourceColumnName")
                                                 .build()))
                                         .build())
                                 .build())
                         .pivotStep(PivotOperationProperty.builder()
                                 .alias("alias")
                                 .pivotConfiguration(PivotConfigurationProperty.builder()
                                         .pivotedLabels(List.of(PivotedLabelProperty.builder()
                                                 .labelName("labelName")
                                                 .newColumnId("newColumnId")
                                                 .newColumnName("newColumnName")
                                                 .build()))
                                         // the properties below are optional
                                         .labelColumnName("labelColumnName")
                                         .build())
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .valueColumnConfiguration(ValueColumnConfigurationProperty.builder()
                                         .aggregationFunction(DataPrepAggregationFunctionProperty.builder()
                                                 .listAggregation(DataPrepListAggregationFunctionProperty.builder()
                                                         .distinct(false)
                                                         .separator("separator")
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .percentileAggregation(DataPrepPercentileAggregationFunctionProperty.builder()
                                                         .percentileValue(123)
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .simpleAggregation(DataPrepSimpleAggregationFunctionProperty.builder()
                                                         .functionType("functionType")
                                                         // the properties below are optional
                                                         .inputColumnName("inputColumnName")
                                                         .build())
                                                 .build())
                                         .build())
                                 // the properties below are optional
                                 .groupByColumnNames(List.of("groupByColumnNames"))
                                 .build())
                         .projectStep(ProjectOperationProperty.builder()
                                 .alias("alias")
                                 .projectedColumns(List.of("projectedColumns"))
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .renameColumnsStep(RenameColumnsOperationProperty.builder()
                                 .alias("alias")
                                 .renameColumnOperations(List.of(RenameColumnOperationProperty.builder()
                                         .columnName("columnName")
                                         .newColumnName("newColumnName")
                                         .build()))
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .build())
                         .unpivotStep(UnpivotOperationProperty.builder()
                                 .alias("alias")
                                 .columnsToUnpivot(List.of(ColumnToUnpivotProperty.builder()
                                         .columnName("columnName")
                                         .newValue("newValue")
                                         .build()))
                                 .source(TransformOperationSourceProperty.builder()
                                         .transformOperationId("transformOperationId")
                                         // the properties below are optional
                                         .columnIdMappings(List.of(DataSetColumnIdMappingProperty.builder()
                                                 .sourceColumnId("sourceColumnId")
                                                 .targetColumnId("targetColumnId")
                                                 .build()))
                                         .build())
                                 .unpivotedLabelColumnId("unpivotedLabelColumnId")
                                 .unpivotedLabelColumnName("unpivotedLabelColumnName")
                                 .unpivotedValueColumnId("unpivotedValueColumnId")
                                 .unpivotedValueColumnName("unpivotedValueColumnName")
                                 .build())
                         .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.DataPrepConfigurationProperty.Builder	builder()
Object	getDestinationTableMap()	A map of destination tables that receive the final prepared data.
Object	getSourceTableMap()	A map of source tables that provide information about underlying sources.
Object	getTransformStepMap()	A map of transformation steps that process the data.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDestinationTableMap

@Stability(Stable)
@NotNull
Object getDestinationTableMap()

A map of destination tables that receive the final prepared data.

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

See Also:

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

getSourceTableMap

@Stability(Stable)
@NotNull
Object getSourceTableMap()

A map of source tables that provide information about underlying sources.

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

See Also:

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

getTransformStepMap

@Stability(Stable)
@NotNull
Object getTransformStepMap()

A map of transformation steps that process the data.

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

See Also:

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

builder

@Stability(Stable)
static CfnDataSet.DataPrepConfigurationProperty.Builder builder()

Returns:

a CfnDataSet.DataPrepConfigurationProperty.Builder of CfnDataSet.DataPrepConfigurationProperty