interface TransformStepProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnDataSet.TransformStepProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnDataSet_TransformStepProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnDataSet.TransformStepProperty`
Python	`aws_cdk.aws_quicksight.CfnDataSet.TransformStepProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnDataSet` » `TransformStepProperty`

A step in data preparation that performs a specific operation on the data.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const transformStepProperty: quicksight.CfnDataSet.TransformStepProperty = {
  aggregateStep: {
    aggregations: [{
      aggregationFunction: {
        listAggregation: {
          distinct: false,
          separator: 'separator',

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
        percentileAggregation: {
          percentileValue: 123,

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
        simpleAggregation: {
          functionType: 'functionType',

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
      },
      newColumnId: 'newColumnId',
      newColumnName: 'newColumnName',
    }],
    alias: 'alias',
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },

    // the properties below are optional
    groupByColumnNames: ['groupByColumnNames'],
  },
  appendStep: {
    alias: 'alias',
    appendedColumns: [{
      columnName: 'columnName',
      newColumnId: 'newColumnId',
    }],

    // the properties below are optional
    firstSource: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
    secondSource: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  castColumnTypesStep: {
    alias: 'alias',
    castColumnTypeOperations: [{
      columnName: 'columnName',
      newColumnType: 'newColumnType',

      // the properties below are optional
      format: 'format',
      subType: 'subType',
    }],
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  createColumnsStep: {
    columns: [{
      columnId: 'columnId',
      columnName: 'columnName',
      expression: 'expression',
    }],

    // the properties below are optional
    alias: 'alias',
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  filtersStep: {
    alias: 'alias',
    filterOperations: [{
      conditionExpression: 'conditionExpression',
      dateFilterCondition: {
        columnName: 'columnName',
        comparisonFilterCondition: {
          operator: 'operator',

          // the properties below are optional
          value: {
            staticValue: 'staticValue',
          },
        },
        rangeFilterCondition: {
          includeMaximum: false,
          includeMinimum: false,
          rangeMaximum: {
            staticValue: 'staticValue',
          },
          rangeMinimum: {
            staticValue: 'staticValue',
          },
        },
      },
      numericFilterCondition: {
        columnName: 'columnName',
        comparisonFilterCondition: {
          operator: 'operator',

          // the properties below are optional
          value: {
            staticValue: 123,
          },
        },
        rangeFilterCondition: {
          includeMaximum: false,
          includeMinimum: false,
          rangeMaximum: {
            staticValue: 123,
          },
          rangeMinimum: {
            staticValue: 123,
          },
        },
      },
      stringFilterCondition: {
        columnName: 'columnName',
        comparisonFilterCondition: {
          operator: 'operator',

          // the properties below are optional
          value: {
            staticValue: 'staticValue',
          },
        },
        listFilterCondition: {
          operator: 'operator',

          // the properties below are optional
          values: {
            staticValues: ['staticValues'],
          },
        },
      },
    }],
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  importTableStep: {
    alias: 'alias',
    source: {
      sourceTableId: 'sourceTableId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  joinStep: {
    alias: 'alias',
    leftOperand: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
    onClause: 'onClause',
    rightOperand: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
    type: 'type',

    // the properties below are optional
    leftOperandProperties: {
      outputColumnNameOverrides: [{
        outputColumnName: 'outputColumnName',

        // the properties below are optional
        sourceColumnName: 'sourceColumnName',
      }],
    },
    rightOperandProperties: {
      outputColumnNameOverrides: [{
        outputColumnName: 'outputColumnName',

        // the properties below are optional
        sourceColumnName: 'sourceColumnName',
      }],
    },
  },
  pivotStep: {
    alias: 'alias',
    pivotConfiguration: {
      pivotedLabels: [{
        labelName: 'labelName',
        newColumnId: 'newColumnId',
        newColumnName: 'newColumnName',
      }],

      // the properties below are optional
      labelColumnName: 'labelColumnName',
    },
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
    valueColumnConfiguration: {
      aggregationFunction: {
        listAggregation: {
          distinct: false,
          separator: 'separator',

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
        percentileAggregation: {
          percentileValue: 123,

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
        simpleAggregation: {
          functionType: 'functionType',

          // the properties below are optional
          inputColumnName: 'inputColumnName',
        },
      },
    },

    // the properties below are optional
    groupByColumnNames: ['groupByColumnNames'],
  },
  projectStep: {
    alias: 'alias',
    projectedColumns: ['projectedColumns'],
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  renameColumnsStep: {
    alias: 'alias',
    renameColumnOperations: [{
      columnName: 'columnName',
      newColumnName: 'newColumnName',
    }],
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
  },
  unpivotStep: {
    alias: 'alias',
    columnsToUnpivot: [{
      columnName: 'columnName',
      newValue: 'newValue',
    }],
    source: {
      transformOperationId: 'transformOperationId',

      // the properties below are optional
      columnIdMappings: [{
        sourceColumnId: 'sourceColumnId',
        targetColumnId: 'targetColumnId',
      }],
    },
    unpivotedLabelColumnId: 'unpivotedLabelColumnId',
    unpivotedLabelColumnName: 'unpivotedLabelColumnName',
    unpivotedValueColumnId: 'unpivotedValueColumnId',
    unpivotedValueColumnName: 'unpivotedValueColumnName',
  },
};

Properties

Name	Type	Description
aggregateStep?	`IResolvable` `\|` `AggregateOperationProperty`	A transform step that groups data and applies aggregation functions to calculate summary values.
appendStep?	`IResolvable` `\|` `AppendOperationProperty`	A transform step that combines rows from multiple sources by stacking them vertically.
castColumnTypesStep?	`IResolvable` `\|` `CastColumnTypesOperationProperty`	A transform step that changes the data types of one or more columns.
createColumnsStep?	`IResolvable` `\|` `CreateColumnsOperationProperty`	A transform operation that creates calculated columns.
filtersStep?	`IResolvable` `\|` `FiltersOperationProperty`	A transform step that applies filter conditions.
importTableStep?	`IResolvable` `\|` `ImportTableOperationProperty`	A transform step that brings data from a source table.
joinStep?	`IResolvable` `\|` `JoinOperationProperty`	A transform step that combines data from two sources based on specified join conditions.
pivotStep?	`IResolvable` `\|` `PivotOperationProperty`	A transform step that converts row values into columns to reshape the data structure.
projectStep?	`IResolvable` `\|` `ProjectOperationProperty`	A transform operation that projects columns.
renameColumnsStep?	`IResolvable` `\|` `RenameColumnsOperationProperty`	A transform step that changes the names of one or more columns.
unpivotStep?	`IResolvable` `\|` `UnpivotOperationProperty`	A transform step that converts columns into rows to normalize the data structure.