Package software.amazon.awscdk.cfnpropertymixins.services.quicksight

Interface CfnDataSetPropsMixin.AggregationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSetPropsMixin.AggregationProperty.Jsii$Proxy

Enclosing class:

CfnDataSetPropsMixin

@Stability(Stable)
public static interface CfnDataSetPropsMixin.AggregationProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.cfnpropertymixins.services.quicksight.*;
 AggregationProperty aggregationProperty = AggregationProperty.builder()
         .aggregationFunction(DataPrepAggregationFunctionProperty.builder()
                 .listAggregation(DataPrepListAggregationFunctionProperty.builder()
                         .distinct(false)
                         .inputColumnName("inputColumnName")
                         .separator("separator")
                         .build())
                 .percentileAggregation(DataPrepPercentileAggregationFunctionProperty.builder()
                         .inputColumnName("inputColumnName")
                         .percentileValue(123)
                         .build())
                 .simpleAggregation(DataPrepSimpleAggregationFunctionProperty.builder()
                         .functionType("functionType")
                         .inputColumnName("inputColumnName")
                         .build())
                 .build())
         .newColumnId("newColumnId")
         .newColumnName("newColumnName")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDataSetPropsMixin.AggregationProperty.Builder	A builder for CfnDataSetPropsMixin.AggregationProperty
static final class	CfnDataSetPropsMixin.AggregationProperty.Jsii$Proxy	An implementation for CfnDataSetPropsMixin.AggregationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSetPropsMixin.AggregationProperty.Builder	builder()
default Object	getAggregationFunction()	The aggregation function to apply, such as SUM , COUNT , AVERAGE , MIN , MAX.
default String	getNewColumnId()	A unique identifier for the new column that will contain the aggregated values.
default String	getNewColumnName()	The name for the new column that will contain the aggregated values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAggregationFunction

@Stability(Stable)
@Nullable
default Object getAggregationFunction()

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

Returns union: either IResolvable or CfnDataSetPropsMixin.DataPrepAggregationFunctionProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-aggregationfunction

getNewColumnId

@Stability(Stable)
@Nullable
default String getNewColumnId()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnid

getNewColumnName

@Stability(Stable)
@Nullable
default String getNewColumnName()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dataset-aggregation.html#cfn-quicksight-dataset-aggregation-newcolumnname

builder

@Stability(Stable)
static CfnDataSetPropsMixin.AggregationProperty.Builder builder()

Returns:

a CfnDataSetPropsMixin.AggregationProperty.Builder of CfnDataSetPropsMixin.AggregationProperty