AWS::QuickSight::Dashboard TotalOptions

The total options for a table visual.

Syntax

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

JSON

{
  "CustomLabel" : String,
  "Placement" : String,
  "ScrollStatus" : String,
  "TotalAggregationOptions" : [ TotalAggregationOption, ... ],
  "TotalCellStyle" : TableCellStyle,
  "TotalsVisibility" : String
}

YAML

  CustomLabel: String
  Placement: String
  ScrollStatus: String
  TotalAggregationOptions: 
    - TotalAggregationOption
  TotalCellStyle: 
    TableCellStyle
  TotalsVisibility: String

Properties

CustomLabel

The custom label string for the total cells.

Required: No

Type: String

Update requires: No interruption

Placement

The placement (start, end) for the total cells.

Required: No

Type: String

Allowed values: START | END | AUTO

Update requires: No interruption

ScrollStatus

The scroll status (pinned, scrolled) for the total cells.

Required: No

Type: String

Allowed values: PINNED | SCROLLED

Update requires: No interruption

TotalAggregationOptions

The total aggregation settings for each value field.

Required: No

Type: Array of TotalAggregationOption

Minimum: 0

Maximum: 200

Update requires: No interruption

TotalCellStyle

Cell styling options for the total cells.

Required: No

Type: TableCellStyle

Update requires: No interruption

TotalsVisibility

The visibility configuration for the total cells.

Required: No

Type: String

Allowed values: HIDDEN | VISIBLE

Update requires: No interruption