interface DataPrepConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.QuickSight.Mixins.CfnDataSetPropsMixin.DataPrepConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsquicksight/mixins#CfnDataSetPropsMixin_DataPrepConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.quicksight.mixins.CfnDataSetPropsMixin.DataPrepConfigurationProperty
Python	aws_cdk.mixins_preview.aws_quicksight.mixins.CfnDataSetPropsMixin.DataPrepConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_quicksight » mixins » CfnDataSetPropsMixin » DataPrepConfigurationProperty

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

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

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as quicksight_mixins } from '@aws-cdk/mixins-preview/aws-quicksight';
const dataPrepConfigurationProperty: quicksight_mixins.CfnDataSetPropsMixin.DataPrepConfigurationProperty = {
  destinationTableMap: {
    destinationTableMapKey: {
      alias: 'alias',
      source: {
        transformOperationId: 'transformOperationId',
      },
    },
  },
  sourceTableMap: {
    sourceTableMapKey: {
      dataSet: {
        dataSetArn: 'dataSetArn',
        inputColumns: [{
          id: 'id',
          name: 'name',
          subType: 'subType',
          type: 'type',
        }],
      },
      physicalTableId: 'physicalTableId',
    },
  },
  transformStepMap: {
    transformStepMapKey: {
      aggregateStep: {
        aggregations: [{
          aggregationFunction: {
            listAggregation: {
              distinct: false,
              inputColumnName: 'inputColumnName',
              separator: 'separator',
            },
            percentileAggregation: {
              inputColumnName: 'inputColumnName',
              percentileValue: 123,
            },
            simpleAggregation: {
              functionType: 'functionType',
              inputColumnName: 'inputColumnName',
            },
          },
          newColumnId: 'newColumnId',
          newColumnName: 'newColumnName',
        }],
        alias: 'alias',
        groupByColumnNames: ['groupByColumnNames'],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      appendStep: {
        alias: 'alias',
        appendedColumns: [{
          columnName: 'columnName',
          newColumnId: 'newColumnId',
        }],
        firstSource: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
        secondSource: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      castColumnTypesStep: {
        alias: 'alias',
        castColumnTypeOperations: [{
          columnName: 'columnName',
          format: 'format',
          newColumnType: 'newColumnType',
          subType: 'subType',
        }],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      createColumnsStep: {
        alias: 'alias',
        columns: [{
          columnId: 'columnId',
          columnName: 'columnName',
          expression: 'expression',
        }],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      filtersStep: {
        alias: 'alias',
        filterOperations: [{
          conditionExpression: 'conditionExpression',
          dateFilterCondition: {
            columnName: 'columnName',
            comparisonFilterCondition: {
              operator: 'operator',
              value: {
                staticValue: 'staticValue',
              },
            },
            rangeFilterCondition: {
              includeMaximum: false,
              includeMinimum: false,
              rangeMaximum: {
                staticValue: 'staticValue',
              },
              rangeMinimum: {
                staticValue: 'staticValue',
              },
            },
          },
          numericFilterCondition: {
            columnName: 'columnName',
            comparisonFilterCondition: {
              operator: 'operator',
              value: {
                staticValue: 123,
              },
            },
            rangeFilterCondition: {
              includeMaximum: false,
              includeMinimum: false,
              rangeMaximum: {
                staticValue: 123,
              },
              rangeMinimum: {
                staticValue: 123,
              },
            },
          },
          stringFilterCondition: {
            columnName: 'columnName',
            comparisonFilterCondition: {
              operator: 'operator',
              value: {
                staticValue: 'staticValue',
              },
            },
            listFilterCondition: {
              operator: 'operator',
              values: {
                staticValues: ['staticValues'],
              },
            },
          },
        }],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      importTableStep: {
        alias: 'alias',
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          sourceTableId: 'sourceTableId',
        },
      },
      joinStep: {
        alias: 'alias',
        leftOperand: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
        leftOperandProperties: {
          outputColumnNameOverrides: [{
            outputColumnName: 'outputColumnName',
            sourceColumnName: 'sourceColumnName',
          }],
        },
        onClause: 'onClause',
        rightOperand: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
        rightOperandProperties: {
          outputColumnNameOverrides: [{
            outputColumnName: 'outputColumnName',
            sourceColumnName: 'sourceColumnName',
          }],
        },
        type: 'type',
      },
      pivotStep: {
        alias: 'alias',
        groupByColumnNames: ['groupByColumnNames'],
        pivotConfiguration: {
          labelColumnName: 'labelColumnName',
          pivotedLabels: [{
            labelName: 'labelName',
            newColumnId: 'newColumnId',
            newColumnName: 'newColumnName',
          }],
        },
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
        valueColumnConfiguration: {
          aggregationFunction: {
            listAggregation: {
              distinct: false,
              inputColumnName: 'inputColumnName',
              separator: 'separator',
            },
            percentileAggregation: {
              inputColumnName: 'inputColumnName',
              percentileValue: 123,
            },
            simpleAggregation: {
              functionType: 'functionType',
              inputColumnName: 'inputColumnName',
            },
          },
        },
      },
      projectStep: {
        alias: 'alias',
        projectedColumns: ['projectedColumns'],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      renameColumnsStep: {
        alias: 'alias',
        renameColumnOperations: [{
          columnName: 'columnName',
          newColumnName: 'newColumnName',
        }],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
      },
      unpivotStep: {
        alias: 'alias',
        columnsToUnpivot: [{
          columnName: 'columnName',
          newValue: 'newValue',
        }],
        source: {
          columnIdMappings: [{
            sourceColumnId: 'sourceColumnId',
            targetColumnId: 'targetColumnId',
          }],
          transformOperationId: 'transformOperationId',
        },
        unpivotedLabelColumnId: 'unpivotedLabelColumnId',
        unpivotedLabelColumnName: 'unpivotedLabelColumnName',
        unpivotedValueColumnId: 'unpivotedValueColumnId',
        unpivotedValueColumnName: 'unpivotedValueColumnName',
      },
    },
  },
};

Properties

Name	Type	Description
destinationTableMap?	IResolvable | { [string]: IResolvable | DestinationTableProperty }	A map of destination tables that receive the final prepared data.
sourceTableMap?	IResolvable | { [string]: IResolvable | SourceTableProperty }	A map of source tables that provide information about underlying sources.
transformStepMap?	IResolvable | { [string]: IResolvable | TransformStepProperty }	A map of transformation steps that process the data.

---

destinationTableMap?

Type: IResolvable | { [string]: IResolvable | DestinationTableProperty } (optional)

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

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

---

sourceTableMap?

Type: IResolvable | { [string]: IResolvable | SourceTableProperty } (optional)

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

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

---

transformStepMap?

Type: IResolvable | { [string]: IResolvable | TransformStepProperty } (optional)

A map of transformation steps that process the data.

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