interface AggregationFunctionProperty

Language	Type name
.NET	`Amazon.CDK.AWS.QuickSight.CfnTemplate.AggregationFunctionProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsquicksight#CfnTemplate_AggregationFunctionProperty`
Java	`software.amazon.awscdk.services.quicksight.CfnTemplate.AggregationFunctionProperty`
Python	`aws_cdk.aws_quicksight.CfnTemplate.AggregationFunctionProperty`
TypeScript	`aws-cdk-lib` » `aws_quicksight` » `CfnTemplate` » `AggregationFunctionProperty`

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 { aws_quicksight as quicksight } from 'aws-cdk-lib';
const aggregationFunctionProperty: quicksight.CfnTemplate.AggregationFunctionProperty = {
  attributeAggregationFunction: {
    simpleAttributeAggregation: 'simpleAttributeAggregation',
    valueForMultipleValues: 'valueForMultipleValues',
  },
  categoricalAggregationFunction: 'categoricalAggregationFunction',
  dateAggregationFunction: 'dateAggregationFunction',
  numericalAggregationFunction: {
    percentileAggregation: {
      percentileValue: 123,
    },
    simpleNumericalAggregation: 'simpleNumericalAggregation',
  },
};

Properties

Name	Type	Description
attributeAggregationFunction?	`IResolvable` `\|` `AttributeAggregationFunctionProperty`	Aggregation for attributes.
categoricalAggregationFunction?	`string`	Aggregation for categorical values.
dateAggregationFunction?	`string`	Aggregation for date values.
numericalAggregationFunction?	`IResolvable` `\|` `NumericalAggregationFunctionProperty`	Aggregation for numerical values.

attributeAggregationFunction?

Type: IResolvable | AttributeAggregationFunctionProperty (optional)

Aggregation for attributes.

categoricalAggregationFunction?

Type: string (optional)

Aggregation for categorical values.

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

dateAggregationFunction?

Type: string (optional)

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.

numericalAggregationFunction?

Type: IResolvable | NumericalAggregationFunctionProperty (optional)

Aggregation for numerical values.