Package software.amazon.awscdk.services.quicksight

Interface CfnTemplate.AggregationFunctionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnTemplate.AggregationFunctionProperty.Jsii$Proxy

Enclosing class:

CfnTemplate

@Stability(Stable)
public static interface CfnTemplate.AggregationFunctionProperty
extends software.amazon.jsii.JsiiSerializable

An aggregation function aggregates values from a dimension or measure.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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.*;
 AggregationFunctionProperty aggregationFunctionProperty = AggregationFunctionProperty.builder()
         .attributeAggregationFunction(AttributeAggregationFunctionProperty.builder()
                 .simpleAttributeAggregation("simpleAttributeAggregation")
                 .valueForMultipleValues("valueForMultipleValues")
                 .build())
         .categoricalAggregationFunction("categoricalAggregationFunction")
         .dateAggregationFunction("dateAggregationFunction")
         .numericalAggregationFunction(NumericalAggregationFunctionProperty.builder()
                 .percentileAggregation(PercentileAggregationProperty.builder()
                         .percentileValue(123)
                         .build())
                 .simpleNumericalAggregation("simpleNumericalAggregation")
                 .build())
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnTemplate.AggregationFunctionProperty.Builder	builder()
default Object	getAttributeAggregationFunction()	Aggregation for attributes.
default String	getCategoricalAggregationFunction()	Aggregation for categorical values.
default String	getDateAggregationFunction()	Aggregation for date values.
default Object	getNumericalAggregationFunction()	Aggregation for numerical values.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAttributeAggregationFunction

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

Aggregation for attributes.

See Also:

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

getCategoricalAggregationFunction

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

Aggregation for categorical values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.

See Also:

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

getDateAggregationFunction

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

Aggregation for date values.

• COUNT : Aggregate by the total number of values, including duplicates.
• DISTINCT_COUNT : Aggregate by the total number of distinct values.
• MIN : Select the smallest date value.
• MAX : Select the largest date value.

See Also:

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

getNumericalAggregationFunction

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

Aggregation for numerical values.

See Also:

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

builder

@Stability(Stable)
static CfnTemplate.AggregationFunctionProperty.Builder builder()

Returns:

a CfnTemplate.AggregationFunctionProperty.Builder of CfnTemplate.AggregationFunctionProperty