Package software.amazon.awscdk.services.quicksight

Interface CfnDataSet.AggregationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDataSet.AggregationProperty.Jsii$Proxy

Enclosing class:

CfnDataSet

@Stability(Stable)
public static interface CfnDataSet.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.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();
 

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	CfnDataSet.AggregationProperty.Builder	A builder for CfnDataSet.AggregationProperty
static final class	CfnDataSet.AggregationProperty.Jsii$Proxy	An implementation for CfnDataSet.AggregationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDataSet.AggregationProperty.Builder	builder()
Object	getAggregationFunction()	The aggregation function to apply, such as SUM , COUNT , AVERAGE , MIN , MAX.
String	getNewColumnId()	A unique identifier for the new column that will contain the aggregated values.
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)
@NotNull
Object getAggregationFunction()

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

Returns union: either IResolvable or CfnDataSet.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)
@NotNull
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)
@NotNull
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 CfnDataSet.AggregationProperty.Builder builder()

Returns:

a CfnDataSet.AggregationProperty.Builder of CfnDataSet.AggregationProperty