AWS::QuickSight::Template CategoricalDimensionField

The dimension type field with categorical type columns..

Syntax

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

JSON

{
  "Column" : ColumnIdentifier,
  "FieldId" : String,
  "FormatConfiguration" : StringFormatConfiguration,
  "HierarchyId" : String
}

YAML

  Column: 
    ColumnIdentifier
  FieldId: String
  FormatConfiguration: 
    StringFormatConfiguration
  HierarchyId: String

Properties

Column

The column that is used in the CategoricalDimensionField.

Required: Yes

Type: ColumnIdentifier

Update requires: No interruption

FieldId

The custom field ID.

Required: Yes

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

FormatConfiguration

The format configuration of the field.

Required: No

Type: StringFormatConfiguration

Update requires: No interruption

HierarchyId

The custom hierarchy ID.

Required: No

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption