# PivotTableSortByProperty

The sort by field for the field sort options.

- Source: Generated code
- Type last changed: v2.93.0 · 23 Aug 2023

## 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 pivotTableSortByProperty: quicksight.CfnAnalysis.PivotTableSortByProperty = {
  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

- `column`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.ColumnSortProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.ColumnSortProperty.html) — The column sort (field id, direction) for the pivot table sort by options.

- `dataPath`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.DataPathSortProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.DataPathSortProperty.html) — The data path sort (data path value, direction) for the pivot table sort by options.

- `field`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnAnalysis.FieldSortProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnAnalysis.FieldSortProperty.html) — The field sort (field id, direction) for the pivot table sort by options.
