AWS::QuickSight::Topic TopicCalculatedField - AWS CloudFormation
SyntaxProperties

This is the new AWS CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::QuickSight::Topic TopicCalculatedField

A structure that represents a calculated field.

Syntax

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

JSON

{
  "Aggregation" : String,
  "AllowedAggregations" : [ String, ... ],
  "CalculatedFieldDescription" : String,
  "CalculatedFieldName" : String,
  "CalculatedFieldSynonyms" : [ String, ... ],
  "CellValueSynonyms" : [ CellValueSynonym, ... ],
  "ColumnDataRole" : String,
  "ComparativeOrder" : ComparativeOrder,
  "DefaultFormatting" : DefaultFormatting,
  "DisableIndexing" : Boolean,
  "Expression" : String,
  "IsIncludedInTopic" : Boolean,
  "NeverAggregateInFilter" : Boolean,
  "NonAdditive" : Boolean,
  "NotAllowedAggregations" : [ String, ... ],
  "SemanticType" : SemanticType,
  "TimeGranularity" : String
}

Properties

Aggregation

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

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 calculated field. 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

CalculatedFieldDescription

The calculated field description.

Required: No

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

CalculatedFieldName

The calculated field name.

Required: Yes

Type: String

Minimum: 0

Maximum: 256

Update requires: No interruption

CalculatedFieldSynonyms

The other names or aliases for the calculated field.

Required: No

Type: Array of String

Minimum: 0

Maximum: 256

Update requires: No interruption

CellValueSynonyms

The other names or aliases for the calculated field cell value.

Required: No

Type: Array of CellValueSynonym

Update requires: No interruption

ColumnDataRole

The column data role for a calculated field. Valid values for this structure are DIMENSION and MEASURE.

Required: No

Type: String

Allowed values: DIMENSION | MEASURE

Update requires: No interruption

ComparativeOrder

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

Required: No

Type: ComparativeOrder

Update requires: No interruption

DefaultFormatting

The default formatting definition.

Required: No

Type: DefaultFormatting

Update requires: No interruption

DisableIndexing

A Boolean value that indicates if a calculated field is visible in the autocomplete.

Required: No

Type: Boolean

Update requires: No interruption

Expression

The calculated field expression.

Required: Yes

Type: String

Minimum: 1

Maximum: 4096

Update requires: No interruption

IsIncludedInTopic

A boolean value that indicates if a calculated field is included in the topic.

Required: No

Type: Boolean

Update requires: No interruption

NeverAggregateInFilter

A Boolean value that indicates whether to never aggregate calculated field in filters.

Required: No

Type: Boolean

Update requires: No interruption

NonAdditive

The non additive for the table style target.

Required: No

Type: Boolean

Update requires: No interruption

NotAllowedAggregations

The list of aggregation types that are not allowed for the calculated field. 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.

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