# TopicColumnProperty

Represents a column in a dataset.

- Source: Generated code
- Type last changed: v2.141.0 · 8 May 2024

## 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 topicColumnProperty: quicksight.CfnTopic.TopicColumnProperty = {
  columnName: 'columnName',

  // the properties below are optional
  aggregation: 'aggregation',
  allowedAggregations: ['allowedAggregations'],
  cellValueSynonyms: [{
    cellValue: 'cellValue',
    synonyms: ['synonyms'],
  }],
  columnDataRole: 'columnDataRole',
  columnDescription: 'columnDescription',
  columnFriendlyName: 'columnFriendlyName',
  columnSynonyms: ['columnSynonyms'],
  comparativeOrder: {
    specifedOrder: ['specifedOrder'],
    treatUndefinedSpecifiedValues: 'treatUndefinedSpecifiedValues',
    useOrdering: 'useOrdering',
  },
  defaultFormatting: {
    displayFormat: 'displayFormat',
    displayFormatOptions: {
      blankCellFormat: 'blankCellFormat',
      currencySymbol: 'currencySymbol',
      dateFormat: 'dateFormat',
      decimalSeparator: 'decimalSeparator',
      fractionDigits: 123,
      groupingSeparator: 'groupingSeparator',
      negativeFormat: {
        prefix: 'prefix',
        suffix: 'suffix',
      },
      prefix: 'prefix',
      suffix: 'suffix',
      unitScaler: 'unitScaler',
      useBlankCellFormat: false,
      useGrouping: false,
    },
  },
  disableIndexing: false,
  isIncludedInTopic: false,
  neverAggregateInFilter: false,
  nonAdditive: false,
  notAllowedAggregations: ['notAllowedAggregations'],
  semanticType: {
    falseyCellValue: 'falseyCellValue',
    falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
    subTypeName: 'subTypeName',
    truthyCellValue: 'truthyCellValue',
    truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
    typeName: 'typeName',
    typeParameters: {
      typeParametersKey: 'typeParameters',
    },
  },
  timeGranularity: 'timeGranularity',
};
```

## Properties

- `aggregation`: string — The type of aggregation that is performed on the column data when it's queried.

- `allowedAggregations`: string[] — The list of aggregation types that are allowed for the column.

  Valid values for this structure are `COUNT` , `DISTINCT_COUNT` , `MIN` , `MAX` , `MEDIAN` , `SUM` , `AVERAGE` , `STDEV` , `STDEVP` , `VAR` , `VARP` , and `PERCENTILE` .

- `cellValueSynonyms`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopic.CellValueSynonymProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnTopic.CellValueSynonymProperty.html)[] — The other names or aliases for the column cell value.

- `columnDataRole`: string — The role of the column in the data.

  Valid values are `DIMENSION` and `MEASURE` .

- `columnDescription`: string — A description of the column and its contents.

- `columnFriendlyName`: string — A user-friendly name for the column.

- `columnName`: string (required) — The name of the column.

- `columnSynonyms`: string[] — The other names or aliases for the column.

- `comparativeOrder`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopic.ComparativeOrderProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnTopic.ComparativeOrderProperty.html) — The order in which data is displayed for the column when it's used in a comparative context.

- `defaultFormatting`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopic.DefaultFormattingProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnTopic.DefaultFormattingProperty.html) — The default formatting used for values in the column.

- `disableIndexing`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) — A Boolean value that indicates whether the column shows in the autocomplete functionality.

- `isIncludedInTopic`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — A Boolean value that indicates whether the column is included in the query results.

- `neverAggregateInFilter`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

- `nonAdditive`: boolean | [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) = false — The non additive value for the column.

- `notAllowedAggregations`: string[] — The list of aggregation types that are not allowed for the column.

  Valid values for this structure are `COUNT` , `DISTINCT_COUNT` , `MIN` , `MAX` , `MEDIAN` , `SUM` , `AVERAGE` , `STDEV` , `STDEVP` , `VAR` , `VARP` , and `PERCENTILE` .

- `semanticType`: [IResolvable](/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnTopic.SemanticTypeProperty](/cdk/api/v2/docs/aws-cdk-lib.aws_quicksight.CfnTopic.SemanticTypeProperty.html) — The semantic type of data contained in the column.

- `timeGranularity`: string — The level of time precision that is used to aggregate `DateTime` values.