Skip to content
v2.277.0

DataPrepAggregationFunctionProperty Struct ​

Defines the type of aggregation function to apply to data during data preparation, supporting simple and list aggregations.

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 dataPrepAggregationFunctionProperty: quicksight.CfnDataSet.DataPrepAggregationFunctionProperty = {
  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',
  },
};
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

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

DataPrepAggregationFunctionProperty dataPrepAggregationFunctionProperty = 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();
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 dataPrepAggregationFunctionProperty = 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"
    }
};
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"

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

Properties ​

listAggregationoptionalIResolvable | CfnDataSet.DataPrepListAggregationFunctionPropertylist_aggregationoptionaltyping.Union[IResolvable, DataPrepListAggregationFunctionProperty]listAggregationoptionalIResolvableListAggregationoptionalIResolvableListAggregationoptionalinterface{}#
A list aggregation function that concatenates values from multiple rows into a single delimited string.
percentileAggregationoptionalIResolvable | CfnDataSet.DataPrepPercentileAggregationFunctionPropertypercentile_aggregationoptionaltyping.Union[IResolvable, DataPrepPercentileAggregationFunctionProperty]percentileAggregationoptionalIResolvablePercentileAggregationoptionalIResolvablePercentileAggregationoptionalinterface{}#
simpleAggregationoptionalIResolvable | CfnDataSet.DataPrepSimpleAggregationFunctionPropertysimple_aggregationoptionaltyping.Union[IResolvable, DataPrepSimpleAggregationFunctionProperty]simpleAggregationoptionalIResolvableSimpleAggregationoptionalIResolvableSimpleAggregationoptionalinterface{}#
A simple aggregation function such as `SUM` , `COUNT` , `AVERAGE` , `MIN` , `MAX` , `MEDIAN` , `VARIANCE` , or `STANDARD_DEVIATION` .