interface AggregationProperty

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

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

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 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

Name	Type	Description
aggregationFunction	`IResolvable` `\|` `DataPrepAggregationFunctionProperty`	The aggregation function to apply, such as `SUM` , `COUNT` , `AVERAGE` , `MIN` , `MAX`.
newColumnId	`string`	A unique identifier for the new column that will contain the aggregated values.
newColumnName	`string`	The name for the new column that will contain the aggregated values.

aggregationFunction

Type: IResolvable | DataPrepAggregationFunctionProperty

The aggregation function to apply, such as SUM , COUNT , AVERAGE , MIN , MAX.

newColumnId

Type: string

A unique identifier for the new column that will contain the aggregated values.

newColumnName

Type: string

The name for the new column that will contain the aggregated values.