# AggregateOperationProperty

A transform operation that groups rows by specified columns and applies aggregation functions to calculate summary values.

- Source: Generated at build time
- Type last changed: v2.224.0 · 13 Nov 2025

## Example

TypeScript:

```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 aggregateOperationProperty: quicksight.CfnDataSet.AggregateOperationProperty = {
  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'],
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_quicksight as quicksight

aggregate_operation_property = quicksight.CfnDataSet.AggregateOperationProperty(
    aggregations=[quicksight.CfnDataSet.AggregationProperty(
        aggregation_function=quicksight.CfnDataSet.DataPrepAggregationFunctionProperty(
            list_aggregation=quicksight.CfnDataSet.DataPrepListAggregationFunctionProperty(
                distinct=False,
                separator="separator",

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            percentile_aggregation=quicksight.CfnDataSet.DataPrepPercentileAggregationFunctionProperty(
                percentile_value=123,

                # the properties below are optional
                input_column_name="inputColumnName"
            ),
            simple_aggregation=quicksight.CfnDataSet.DataPrepSimpleAggregationFunctionProperty(
                function_type="functionType",

                # the properties below are optional
                input_column_name="inputColumnName"
            )
        ),
        new_column_id="newColumnId",
        new_column_name="newColumnName"
    )],
    alias="alias",
    source=quicksight.CfnDataSet.TransformOperationSourceProperty(
        transform_operation_id="transformOperationId",

        # the properties below are optional
        column_id_mappings=[quicksight.CfnDataSet.DataSetColumnIdMappingProperty(
            source_column_id="sourceColumnId",
            target_column_id="targetColumnId"
        )]
    ),

    # the properties below are optional
    group_by_column_names=["groupByColumnNames"]
)
```

Java:

```java
// 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.*;

AggregateOperationProperty aggregateOperationProperty = 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();
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.QuickSight;

var aggregateOperationProperty = new AggregateOperationProperty {
    Aggregations = new [] { new AggregationProperty {
        AggregationFunction = new DataPrepAggregationFunctionProperty {
            ListAggregation = new DataPrepListAggregationFunctionProperty {
                Distinct = false,
                Separator = "separator",

                // the properties below are optional
                InputColumnName = "inputColumnName"
            },
            PercentileAggregation = new DataPrepPercentileAggregationFunctionProperty {
                PercentileValue = 123,

                // the properties below are optional
                InputColumnName = "inputColumnName"
            },
            SimpleAggregation = new DataPrepSimpleAggregationFunctionProperty {
                FunctionType = "functionType",

                // the properties below are optional
                InputColumnName = "inputColumnName"
            }
        },
        NewColumnId = "newColumnId",
        NewColumnName = "newColumnName"
    } },
    Alias = "alias",
    Source = new TransformOperationSourceProperty {
        TransformOperationId = "transformOperationId",

        // the properties below are optional
        ColumnIdMappings = new [] { new DataSetColumnIdMappingProperty {
            SourceColumnId = "sourceColumnId",
            TargetColumnId = "targetColumnId"
        } }
    },

    // the properties below are optional
    GroupByColumnNames = new [] { "groupByColumnNames" }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

aggregateOperationProperty := &AggregateOperationProperty{
	Aggregations: []interface{}{
		&AggregationProperty{
			AggregationFunction: &DataPrepAggregationFunctionProperty{
				ListAggregation: &DataPrepListAggregationFunctionProperty{
					Distinct: jsii.Boolean(false),
					Separator: jsii.String("separator"),

					// the properties below are optional
					InputColumnName: jsii.String("inputColumnName"),
				},
				PercentileAggregation: &DataPrepPercentileAggregationFunctionProperty{
					PercentileValue: jsii.Number(123),

					// the properties below are optional
					InputColumnName: jsii.String("inputColumnName"),
				},
				SimpleAggregation: &DataPrepSimpleAggregationFunctionProperty{
					FunctionType: jsii.String("functionType"),

					// the properties below are optional
					InputColumnName: jsii.String("inputColumnName"),
				},
			},
			NewColumnId: jsii.String("newColumnId"),
			NewColumnName: jsii.String("newColumnName"),
		},
	},
	Alias: jsii.String("alias"),
	Source: &TransformOperationSourceProperty{
		TransformOperationId: jsii.String("transformOperationId"),

		// the properties below are optional
		ColumnIdMappings: []interface{}{
			&DataSetColumnIdMappingProperty{
				SourceColumnId: jsii.String("sourceColumnId"),
				TargetColumnId: jsii.String("targetColumnId"),
			},
		},
	},

	// the properties below are optional
	GroupByColumnNames: []*string{
		jsii.String("groupByColumnNames"),
	},
}
```

## Properties

- `aggregations`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataSet.AggregationProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnDataSet.AggregationProperty.html)[] (required) — The list of aggregation functions to apply to the grouped data, such as `SUM` , `COUNT` , or `AVERAGE` .

- `alias`: string (required) — Alias for this operation.

- `groupByColumnNames`: string[] — The list of column names to group by when performing the aggregation.

  Rows with the same values in these columns will be grouped together.

- `source`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnDataSet.TransformOperationSourceProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnDataSet.TransformOperationSourceProperty.html) (required) — The source transform operation that provides input data for the aggregation.
