Skip to content
v2.277.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',
};
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

aggregation_property = 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"
)
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.*;

AggregationProperty aggregationProperty = 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();
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 aggregationProperty = 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"
};
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"

aggregationProperty := &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"),
}

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.