Skip to content
v2.277.0

PivotTableSortConfigurationProperty Struct ​

The sort configuration for a PivotTableVisual .

Example ​

ts
// 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 pivotTableSortConfigurationProperty: quicksight.CfnAnalysis.PivotTableSortConfigurationProperty = {
  fieldSortOptions: [{
    fieldId: 'fieldId',
    sortBy: {
      column: {
        direction: 'direction',
        sortBy: {
          columnName: 'columnName',

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

        // the properties below are optional
        aggregationFunction: {
          attributeAggregationFunction: {
            simpleAttributeAggregation: 'simpleAttributeAggregation',
            valueForMultipleValues: 'valueForMultipleValues',
          },
          categoricalAggregationFunction: 'categoricalAggregationFunction',
          dateAggregationFunction: 'dateAggregationFunction',
          numericalAggregationFunction: {
            percentileAggregation: {
              percentileValue: 123,
            },
            simpleNumericalAggregation: 'simpleNumericalAggregation',
          },
        },
      },
      dataPath: {
        direction: 'direction',
        sortPaths: [{
          dataPathType: {
            pivotTableDataPathType: 'pivotTableDataPathType',
          },
          fieldId: 'fieldId',
          fieldValue: 'fieldValue',
        }],
      },
      field: {
        direction: 'direction',
        fieldId: 'fieldId',
      },
    },
  }],
};
python
# 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

pivot_table_sort_configuration_property = quicksight.CfnAnalysis.PivotTableSortConfigurationProperty(
    field_sort_options=[quicksight.CfnAnalysis.PivotFieldSortOptionsProperty(
        field_id="fieldId",
        sort_by=quicksight.CfnAnalysis.PivotTableSortByProperty(
            column=quicksight.CfnAnalysis.ColumnSortProperty(
                direction="direction",
                sort_by=quicksight.CfnAnalysis.ColumnIdentifierProperty(
                    column_name="columnName",

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

                # the properties below are optional
                aggregation_function=quicksight.CfnAnalysis.AggregationFunctionProperty(
                    attribute_aggregation_function=quicksight.CfnAnalysis.AttributeAggregationFunctionProperty(
                        simple_attribute_aggregation="simpleAttributeAggregation",
                        value_for_multiple_values="valueForMultipleValues"
                    ),
                    categorical_aggregation_function="categoricalAggregationFunction",
                    date_aggregation_function="dateAggregationFunction",
                    numerical_aggregation_function=quicksight.CfnAnalysis.NumericalAggregationFunctionProperty(
                        percentile_aggregation=quicksight.CfnAnalysis.PercentileAggregationProperty(
                            percentile_value=123
                        ),
                        simple_numerical_aggregation="simpleNumericalAggregation"
                    )
                )
            ),
            data_path=quicksight.CfnAnalysis.DataPathSortProperty(
                direction="direction",
                sort_paths=[quicksight.CfnAnalysis.DataPathValueProperty(
                    data_path_type=quicksight.CfnAnalysis.DataPathTypeProperty(
                        pivot_table_data_path_type="pivotTableDataPathType"
                    ),
                    field_id="fieldId",
                    field_value="fieldValue"
                )]
            ),
            field=quicksight.CfnAnalysis.FieldSortProperty(
                direction="direction",
                field_id="fieldId"
            )
        )
    )]
)
java
// 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.*;

PivotTableSortConfigurationProperty pivotTableSortConfigurationProperty = PivotTableSortConfigurationProperty.builder()
        .fieldSortOptions(List.of(PivotFieldSortOptionsProperty.builder()
                .fieldId("fieldId")
                .sortBy(PivotTableSortByProperty.builder()
                        .column(ColumnSortProperty.builder()
                                .direction("direction")
                                .sortBy(ColumnIdentifierProperty.builder()
                                        .columnName("columnName")

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

                                // 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())
                        .dataPath(DataPathSortProperty.builder()
                                .direction("direction")
                                .sortPaths(List.of(DataPathValueProperty.builder()
                                        .dataPathType(DataPathTypeProperty.builder()
                                                .pivotTableDataPathType("pivotTableDataPathType")
                                                .build())
                                        .fieldId("fieldId")
                                        .fieldValue("fieldValue")
                                        .build()))
                                .build())
                        .field(FieldSortProperty.builder()
                                .direction("direction")
                                .fieldId("fieldId")
                                .build())
                        .build())
                .build()))
        .build();
csharp
// 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 pivotTableSortConfigurationProperty = new PivotTableSortConfigurationProperty {
    FieldSortOptions = new [] { new PivotFieldSortOptionsProperty {
        FieldId = "fieldId",
        SortBy = new PivotTableSortByProperty {
            Column = new ColumnSortProperty {
                Direction = "direction",
                SortBy = new ColumnIdentifierProperty {
                    ColumnName = "columnName",

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

                // 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"
                    }
                }
            },
            DataPath = new DataPathSortProperty {
                Direction = "direction",
                SortPaths = new [] { new DataPathValueProperty {
                    DataPathType = new DataPathTypeProperty {
                        PivotTableDataPathType = "pivotTableDataPathType"
                    },
                    FieldId = "fieldId",
                    FieldValue = "fieldValue"
                } }
            },
            Field = new FieldSortProperty {
                Direction = "direction",
                FieldId = "fieldId"
            }
        }
    } }
};
go
// 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"

pivotTableSortConfigurationProperty := &PivotTableSortConfigurationProperty{
	FieldSortOptions: []interface{}{
		&PivotFieldSortOptionsProperty{
			FieldId: jsii.String("fieldId"),
			SortBy: &PivotTableSortByProperty{
				Column: &ColumnSortProperty{
					Direction: jsii.String("direction"),
					SortBy: &ColumnIdentifierProperty{
						ColumnName: jsii.String("columnName"),

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

					// 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"),
						},
					},
				},
				DataPath: &DataPathSortProperty{
					Direction: jsii.String("direction"),
					SortPaths: []interface{}{
						&DataPathValueProperty{
							DataPathType: &DataPathTypeProperty{
								PivotTableDataPathType: jsii.String("pivotTableDataPathType"),
							},
							FieldId: jsii.String("fieldId"),
							FieldValue: jsii.String("fieldValue"),
						},
					},
				},
				Field: &FieldSortProperty{
					Direction: jsii.String("direction"),
					FieldId: jsii.String("fieldId"),
				},
			},
		},
	},
}

Properties ​

fieldSortOptionsoptionalIResolvable | IResolvable | CfnAnalysis.PivotFieldSortOptionsProperty[]field_sort_optionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PivotFieldSortOptionsProperty]]]fieldSortOptionsoptionalIResolvableFieldSortOptionsoptionalIResolvableFieldSortOptionsoptionalinterface{}#
The field sort options for a pivot table sort configuration.