Skip to content
v2.274.0

AggregationProperty Struct ​

Defines an aggregation function to be applied to grouped data, creating a new column with the calculated result.

Example ​

ts
// 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 aggregationProperty: quicksight.CfnDataSet.AggregationProperty = {
  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',
};

Properties ​

aggregationFunctionIResolvable | CfnDataSet.DataPrepAggregationFunctionPropertyaggregation_functiontyping.Union[IResolvable, DataPrepAggregationFunctionProperty]aggregationFunctionIResolvableAggregationFunctionIResolvableAggregationFunctioninterface{}required#
The aggregation function to apply, such as `SUM` , `COUNT` , `AVERAGE` , `MIN` , `MAX`.
newColumnIdstringnew_column_idstrnewColumnIdStringNewColumnIdstringNewColumnId*stringrequired#
A unique identifier for the new column that will contain the aggregated values.
newColumnNamestringnew_column_namestrnewColumnNameStringNewColumnNamestringNewColumnName*stringrequired#
The name for the new column that will contain the aggregated values.