aws-cdk-lib.aws_quicksight.CfnTemplate.PivotFieldSortOptionsProperty

PivotFieldSortOptionsProperty Struct

The field sort options for a pivot table sort configuration.

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 pivotFieldSortOptionsProperty: quicksight.CfnTemplate.PivotFieldSortOptionsProperty = {
  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',
    },
  },
};

Properties

fieldIdstringfield_idstrfieldIdStringFieldIdstringFieldId*stringrequired#

The field ID for the field sort options.

sortByIResolvable | CfnTemplate.PivotTableSortByPropertysort_bytyping.Union[IResolvable, PivotTableSortByProperty]sortByIResolvableSortByIResolvableSortByinterface{}required#

The sort by field for the field sort options.