AWS::QuickSight::Analysis KPIVisual
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{ "Actions" :
[ VisualCustomAction, ... ]
, "ChartConfiguration" :KPIConfiguration
, "ColumnHierarchies" :[ ColumnHierarchy, ... ]
, "ConditionalFormatting" :KPIConditionalFormatting
, "Subtitle" :VisualSubtitleLabelOptions
, "Title" :VisualTitleLabelOptions
, "VisualId" :String
}
YAML
Actions:
- VisualCustomAction
ChartConfiguration:KPIConfiguration
ColumnHierarchies:- ColumnHierarchy
ConditionalFormatting:KPIConditionalFormatting
Subtitle:VisualSubtitleLabelOptions
Title:VisualTitleLabelOptions
VisualId:String
Properties
Actions
-
The list of custom actions that are configured for a visual.
Required: No
Type: Array of VisualCustomAction
Minimum:
0
Maximum:
10
Update requires: No interruption
ChartConfiguration
-
The configuration of a KPI visual.
Required: No
Type: KPIConfiguration
Update requires: No interruption
ColumnHierarchies
-
The column hierarchy that is used during drill-downs and drill-ups.
Required: No
Type: Array of ColumnHierarchy
Minimum:
0
Maximum:
2
Update requires: No interruption
ConditionalFormatting
-
The conditional formatting of a KPI visual.
Required: No
Type: KPIConditionalFormatting
Update requires: No interruption
Subtitle
-
The subtitle that is displayed on the visual.
Required: No
Type: VisualSubtitleLabelOptions
Update requires: No interruption
Title
-
The title that is displayed on the visual.
Required: No
Type: VisualTitleLabelOptions
Update requires: No interruption
VisualId
-
The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.
Required: Yes
Type: String
Pattern:
^[\w\-]+$
Minimum:
1
Maximum:
512
Update requires: No interruption