AWS::QuickSight::Analysis KPIOptions

The options that determine the presentation of a KPI visual.

Syntax

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

JSON

{
  "Comparison" : ComparisonConfiguration,
  "PrimaryValueDisplayType" : String,
  "PrimaryValueFontConfiguration" : FontConfiguration,
  "ProgressBar" : ProgressBarOptions,
  "SecondaryValue" : SecondaryValueOptions,
  "SecondaryValueFontConfiguration" : FontConfiguration,
  "Sparkline" : KPISparklineOptions,
  "TrendArrows" : TrendArrowOptions,
  "VisualLayoutOptions" : KPIVisualLayoutOptions
}

YAML

  Comparison: 
    ComparisonConfiguration
  PrimaryValueDisplayType: String
  PrimaryValueFontConfiguration: 
    FontConfiguration
  ProgressBar: 
    ProgressBarOptions
  SecondaryValue: 
    SecondaryValueOptions
  SecondaryValueFontConfiguration: 
    FontConfiguration
  Sparkline: 
    KPISparklineOptions
  TrendArrows: 
    TrendArrowOptions
  VisualLayoutOptions: 
    KPIVisualLayoutOptions

Properties

Comparison

The comparison configuration of a KPI visual.

Required: No

Type: ComparisonConfiguration

Update requires: No interruption

PrimaryValueDisplayType

The options that determine the primary value display type.

Required: No

Type: String

Allowed values: HIDDEN | COMPARISON | ACTUAL

Update requires: No interruption

PrimaryValueFontConfiguration

The options that determine the primary value font configuration.

Required: No

Type: FontConfiguration

Update requires: No interruption

ProgressBar

The options that determine the presentation of the progress bar of a KPI visual.

Required: No

Type: ProgressBarOptions

Update requires: No interruption

SecondaryValue

The options that determine the presentation of the secondary value of a KPI visual.

Required: No

Type: SecondaryValueOptions

Update requires: No interruption

SecondaryValueFontConfiguration

The options that determine the secondary value font configuration.

Required: No

Type: FontConfiguration

Update requires: No interruption

Sparkline

The options that determine the visibility, color, type, and tooltip visibility of the sparkline of a KPI visual.

Required: No

Type: KPISparklineOptions

Update requires: No interruption

TrendArrows

The options that determine the presentation of trend arrows in a KPI visual.

Required: No

Type: TrendArrowOptions

Update requires: No interruption

VisualLayoutOptions

The options that determine the layout a KPI visual.

Required: No

Type: KPIVisualLayoutOptions

Update requires: No interruption