aws-cdk-lib.aws_quicksight.CfnTemplate.AggregationSortConfigurationProperty

AggregationSortConfigurationProperty Struct

The configuration options to sort aggregated values.

Source

Generated code

Type last changed

v2.93.0 · 23 Aug 2023

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 aggregationSortConfigurationProperty: quicksight.CfnTemplate.AggregationSortConfigurationProperty = {
  column: {
    columnName: 'columnName',

    // the properties below are optional
    dataSetIdentifier: 'dataSetIdentifier',
    topicIdentifier: 'topicIdentifier',
  },
  sortDirection: 'sortDirection',

  // the properties below are optional
  aggregationFunction: {
    attributeAggregationFunction: {
      simpleAttributeAggregation: 'simpleAttributeAggregation',
      valueForMultipleValues: 'valueForMultipleValues',
    },
    categoricalAggregationFunction: 'categoricalAggregationFunction',
    dateAggregationFunction: 'dateAggregationFunction',
    numericalAggregationFunction: {
      percentileAggregation: {
        percentileValue: 123,
      },
      simpleNumericalAggregation: 'simpleNumericalAggregation',
    },
  },
};

# 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

aggregation_sort_configuration_property = quicksight.CfnTemplate.AggregationSortConfigurationProperty(
    column=quicksight.CfnTemplate.ColumnIdentifierProperty(
        column_name="columnName",

        # the properties below are optional
        data_set_identifier="dataSetIdentifier",
        topic_identifier="topicIdentifier"
    ),
    sort_direction="sortDirection",

    # the properties below are optional
    aggregation_function=quicksight.CfnTemplate.AggregationFunctionProperty(
        attribute_aggregation_function=quicksight.CfnTemplate.AttributeAggregationFunctionProperty(
            simple_attribute_aggregation="simpleAttributeAggregation",
            value_for_multiple_values="valueForMultipleValues"
        ),
        categorical_aggregation_function="categoricalAggregationFunction",
        date_aggregation_function="dateAggregationFunction",
        numerical_aggregation_function=quicksight.CfnTemplate.NumericalAggregationFunctionProperty(
            percentile_aggregation=quicksight.CfnTemplate.PercentileAggregationProperty(
                percentile_value=123
            ),
            simple_numerical_aggregation="simpleNumericalAggregation"
        )
    )
)

// 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.*;

AggregationSortConfigurationProperty aggregationSortConfigurationProperty = AggregationSortConfigurationProperty.builder()
        .column(ColumnIdentifierProperty.builder()
                .columnName("columnName")

                // the properties below are optional
                .dataSetIdentifier("dataSetIdentifier")
                .topicIdentifier("topicIdentifier")
                .build())
        .sortDirection("sortDirection")

        // the properties below are optional
        .aggregationFunction(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())
        .build();

// 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 aggregationSortConfigurationProperty = new AggregationSortConfigurationProperty {
    Column = new ColumnIdentifierProperty {
        ColumnName = "columnName",

        // the properties below are optional
        DataSetIdentifier = "dataSetIdentifier",
        TopicIdentifier = "topicIdentifier"
    },
    SortDirection = "sortDirection",

    // the properties below are optional
    AggregationFunction = new AggregationFunctionProperty {
        AttributeAggregationFunction = new AttributeAggregationFunctionProperty {
            SimpleAttributeAggregation = "simpleAttributeAggregation",
            ValueForMultipleValues = "valueForMultipleValues"
        },
        CategoricalAggregationFunction = "categoricalAggregationFunction",
        DateAggregationFunction = "dateAggregationFunction",
        NumericalAggregationFunction = new NumericalAggregationFunctionProperty {
            PercentileAggregation = new PercentileAggregationProperty {
                PercentileValue = 123
            },
            SimpleNumericalAggregation = "simpleNumericalAggregation"
        }
    }
};

// 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"

aggregationSortConfigurationProperty := &AggregationSortConfigurationProperty{
	Column: &ColumnIdentifierProperty{
		ColumnName: jsii.String("columnName"),

		// the properties below are optional
		DataSetIdentifier: jsii.String("dataSetIdentifier"),
		TopicIdentifier: jsii.String("topicIdentifier"),
	},
	SortDirection: jsii.String("sortDirection"),

	// the properties below are optional
	AggregationFunction: &AggregationFunctionProperty{
		AttributeAggregationFunction: &AttributeAggregationFunctionProperty{
			SimpleAttributeAggregation: jsii.String("simpleAttributeAggregation"),
			ValueForMultipleValues: jsii.String("valueForMultipleValues"),
		},
		CategoricalAggregationFunction: jsii.String("categoricalAggregationFunction"),
		DateAggregationFunction: jsii.String("dateAggregationFunction"),
		NumericalAggregationFunction: &NumericalAggregationFunctionProperty{
			PercentileAggregation: &PercentileAggregationProperty{
				PercentileValue: jsii.Number(123),
			},
			SimpleNumericalAggregation: jsii.String("simpleNumericalAggregation"),
		},
	},
}

Properties

aggregationFunction?optionalIResolvable | CfnTemplate.AggregationFunctionPropertyaggregation_function?optionaltyping.Union[IResolvable, AggregationFunctionProperty]aggregationFunction?optionalIResolvableAggregationFunction?optionalIResolvableAggregationFunction?optionalinterface{}#

The function that aggregates the values in `Column` .

columnIResolvable | CfnTemplate.ColumnIdentifierPropertycolumntyping.Union[IResolvable, ColumnIdentifierProperty]columnIResolvableColumnIResolvableColumninterface{}required#

The column that determines the sort order of aggregated values.

sortDirectionstringsort_directionstrsortDirectionStringSortDirectionstringSortDirection*stringrequired#

The sort direction of values.

• ASC : Sort in ascending order.
• DESC : Sort in descending order.