interface TopicColumnProperty

Language	Type name
.NET	Amazon.CDK.AWS.QuickSight.CfnTopic.TopicColumnProperty
Java	software.amazon.awscdk.services.quicksight.CfnTopic.TopicColumnProperty
Python	aws_cdk.aws_quicksight.CfnTopic.TopicColumnProperty
TypeScript	@aws-cdk/aws-quicksight » CfnTopic » TopicColumnProperty

Represents a column in a dataset.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as quicksight from '@aws-cdk/aws-quicksight';
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,
    },
  },
  isIncludedInTopic: false,
  neverAggregateInFilter: false,
  notAllowedAggregations: ['notAllowedAggregations'],
  semanticType: {
    falseyCellValue: 'falseyCellValue',
    falseyCellValueSynonyms: ['falseyCellValueSynonyms'],
    subTypeName: 'subTypeName',
    truthyCellValue: 'truthyCellValue',
    truthyCellValueSynonyms: ['truthyCellValueSynonyms'],
    typeName: 'typeName',
    typeParameters: {
      typeParametersKey: 'typeParameters',
    },
  },
  timeGranularity: 'timeGranularity',
};

Properties

Name	Type	Description
columnName	string	The name of the column.
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.
cellValueSynonyms?	IResolvable | IResolvable | CellValueSynonymProperty[]	The other names or aliases for the column cell value.
columnDataRole?	string	The role of the column in the data.
columnDescription?	string	A description of the column and its contents.
columnFriendlyName?	string	A user-friendly name for the column.
columnSynonyms?	string[]	The other names or aliases for the column.
comparativeOrder?	IResolvable | ComparativeOrderProperty	The order in which data is displayed for the column when it's used in a comparative context.
defaultFormatting?	IResolvable | DefaultFormattingProperty	The default formatting used for values in the column.
isIncludedInTopic?	boolean | IResolvable	A Boolean value that indicates whether the column is included in the query results.
neverAggregateInFilter?	boolean | IResolvable	A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.
notAllowedAggregations?	string[]	The list of aggregation types that are not allowed for the column.
semanticType?	IResolvable | SemanticTypeProperty	The semantic type of data contained in the column.
timeGranularity?	string	The level of time precision that is used to aggregate DateTime values.

---

columnName

Type: string

The name of the column.

---

aggregation?

Type: string (optional)

The type of aggregation that is performed on the column data when it's queried.

Valid values for this structure are SUM , MAX , MIN , COUNT , DISTINCT_COUNT , and AVERAGE .

---

allowedAggregations?

Type: string[] (optional)

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?

Type: IResolvable | IResolvable | CellValueSynonymProperty[] (optional)

The other names or aliases for the column cell value.

---

columnDataRole?

Type: string (optional)

The role of the column in the data.

Valid values are DIMENSION and MEASURE .

---

columnDescription?

Type: string (optional)

A description of the column and its contents.

---

columnFriendlyName?

Type: string (optional)

A user-friendly name for the column.

---

columnSynonyms?

Type: string[] (optional)

The other names or aliases for the column.

---

comparativeOrder?

Type: IResolvable | ComparativeOrderProperty (optional)

The order in which data is displayed for the column when it's used in a comparative context.

---

defaultFormatting?

Type: IResolvable | DefaultFormattingProperty (optional)

The default formatting used for values in the column.

---

isIncludedInTopic?

Type: boolean | IResolvable (optional)

A Boolean value that indicates whether the column is included in the query results.

---

neverAggregateInFilter?

Type: boolean | IResolvable (optional)

A Boolean value that indicates whether to aggregate the column data when it's used in a filter context.

---

notAllowedAggregations?

Type: string[] (optional)

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?

Type: IResolvable | SemanticTypeProperty (optional)

The semantic type of data contained in the column.

---

timeGranularity?

Type: string (optional)

The level of time precision that is used to aggregate DateTime values.