AWS::QuickSight::Topic TopicColumn - AWS CloudFormation
SyntaxProperties

AWS::QuickSight::Topic TopicColumn

Represents a column in a dataset.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Aggregation" : String,
  "AllowedAggregations" : [ String, ... ],
  "CellValueSynonyms" : [ CellValueSynonym, ... ],
  "ColumnDataRole" : String,
  "ColumnDescription" : String,
  "ColumnFriendlyName" : String,
  "ColumnName" : String,
  "ColumnSynonyms" : [ String, ... ],
  "ComparativeOrder" : ComparativeOrder,
  "DefaultFormatting" : DefaultFormatting,
  "DisableIndexing" : Boolean,
  "IsIncludedInTopic" : Boolean,
  "NeverAggregateInFilter" : Boolean,
  "NonAdditive" : Boolean,
  "NotAllowedAggregations" : [ String, ... ],
  "SemanticType" : SemanticType,
  "TimeGranularity" : String
}

Properties

Aggregation

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

Required: No

Type: String

Allowed values: SUM | MAX | MIN | COUNT | DISTINCT_COUNT | AVERAGE | MEDIAN | STDEV | STDEVP | VAR | VARP

Update requires: No interruption

AllowedAggregations

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.

Required: No

Type: Array of String

Update requires: No interruption

CellValueSynonyms

The other names or aliases for the column cell value.

Required: No

Type: Array of CellValueSynonym

Update requires: No interruption

ColumnDataRole

The role of the column in the data. Valid values are DIMENSION and MEASURE.

Required: No

Type: String

Allowed values: DIMENSION | MEASURE

Update requires: No interruption

ColumnDescription

A description of the column and its contents.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

ColumnFriendlyName

A user-friendly name for the column.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

ColumnName

The name of the column.

Required: Yes

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

ColumnSynonyms

The other names or aliases for the column.

Required: No

Type: Array of String

Minimum: 0

Maximum: 256

Update requires: No interruption

ComparativeOrder

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

Required: No

Type: ComparativeOrder

Update requires: No interruption

DefaultFormatting

The default formatting used for values in the column.

Required: No

Type: DefaultFormatting

Update requires: No interruption

DisableIndexing

A Boolean value that indicates whether the column shows in the autocomplete functionality.

Required: No

Type: Boolean

Update requires: No interruption

IsIncludedInTopic

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

Required: No

Type: Boolean

Update requires: No interruption

NeverAggregateInFilter

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

Required: No

Type: Boolean

Update requires: No interruption

NonAdditive

The non additive value for the column.

Required: No

Type: Boolean

Update requires: No interruption

NotAllowedAggregations

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.

Required: No

Type: Array of String

Update requires: No interruption

SemanticType

The semantic type of data contained in the column.

Required: No

Type: SemanticType

Update requires: No interruption

TimeGranularity

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

Required: No

Type: String

Allowed values: SECOND | MINUTE | HOUR | DAY | WEEK | MONTH | QUARTER | YEAR

Update requires: No interruption