This is the new *Amazon CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [Amazon CloudFormation User Guide](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::QuickSight::Template KPIVisual
<a name="aws-properties-quicksight-template-kpivisual"></a>

A key performance indicator (KPI).

For more information, see [Using KPIs](https://docs.amazonaws.cn/quicksight/latest/user/kpi.html) in the *Amazon Quick Suite User Guide*.

## Syntax
<a name="aws-properties-quicksight-template-kpivisual-syntax"></a>

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

### JSON
<a name="aws-properties-quicksight-template-kpivisual-syntax.json"></a>

```
{
  "[Actions](#cfn-quicksight-template-kpivisual-actions)" : [ VisualCustomAction, ... ],
  "[ChartConfiguration](#cfn-quicksight-template-kpivisual-chartconfiguration)" : KPIConfiguration,
  "[ColumnHierarchies](#cfn-quicksight-template-kpivisual-columnhierarchies)" : [ ColumnHierarchy, ... ],
  "[ConditionalFormatting](#cfn-quicksight-template-kpivisual-conditionalformatting)" : KPIConditionalFormatting,
  "[Subtitle](#cfn-quicksight-template-kpivisual-subtitle)" : VisualSubtitleLabelOptions,
  "[Title](#cfn-quicksight-template-kpivisual-title)" : VisualTitleLabelOptions,
  "[VisualContentAltText](#cfn-quicksight-template-kpivisual-visualcontentalttext)" : String,
  "[VisualId](#cfn-quicksight-template-kpivisual-visualid)" : String
}
```

### YAML
<a name="aws-properties-quicksight-template-kpivisual-syntax.yaml"></a>

```
  [Actions](#cfn-quicksight-template-kpivisual-actions): 
    - VisualCustomAction
  [ChartConfiguration](#cfn-quicksight-template-kpivisual-chartconfiguration): 
    KPIConfiguration
  [ColumnHierarchies](#cfn-quicksight-template-kpivisual-columnhierarchies): 
    - ColumnHierarchy
  [ConditionalFormatting](#cfn-quicksight-template-kpivisual-conditionalformatting): 
    KPIConditionalFormatting
  [Subtitle](#cfn-quicksight-template-kpivisual-subtitle): 
    VisualSubtitleLabelOptions
  [Title](#cfn-quicksight-template-kpivisual-title): 
    VisualTitleLabelOptions
  [VisualContentAltText](#cfn-quicksight-template-kpivisual-visualcontentalttext): String
  [VisualId](#cfn-quicksight-template-kpivisual-visualid): String
```

## Properties
<a name="aws-properties-quicksight-template-kpivisual-properties"></a>

`Actions`  <a name="cfn-quicksight-template-kpivisual-actions"></a>
The list of custom actions that are configured for a visual.  
*Required*: No  
*Type*: Array of [VisualCustomAction](aws-properties-quicksight-template-visualcustomaction.md)  
*Minimum*: `0`  
*Maximum*: `10`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ChartConfiguration`  <a name="cfn-quicksight-template-kpivisual-chartconfiguration"></a>
The configuration of a KPI visual.  
*Required*: No  
*Type*: [KPIConfiguration](aws-properties-quicksight-template-kpiconfiguration.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ColumnHierarchies`  <a name="cfn-quicksight-template-kpivisual-columnhierarchies"></a>
The column hierarchy that is used during drill-downs and drill-ups.  
*Required*: No  
*Type*: Array of [ColumnHierarchy](aws-properties-quicksight-template-columnhierarchy.md)  
*Minimum*: `0`  
*Maximum*: `2`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`ConditionalFormatting`  <a name="cfn-quicksight-template-kpivisual-conditionalformatting"></a>
The conditional formatting of a KPI visual.  
*Required*: No  
*Type*: [KPIConditionalFormatting](aws-properties-quicksight-template-kpiconditionalformatting.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Subtitle`  <a name="cfn-quicksight-template-kpivisual-subtitle"></a>
The subtitle that is displayed on the visual.  
*Required*: No  
*Type*: [VisualSubtitleLabelOptions](aws-properties-quicksight-template-visualsubtitlelabeloptions.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`Title`  <a name="cfn-quicksight-template-kpivisual-title"></a>
The title that is displayed on the visual.  
*Required*: No  
*Type*: [VisualTitleLabelOptions](aws-properties-quicksight-template-visualtitlelabeloptions.md)  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VisualContentAltText`  <a name="cfn-quicksight-template-kpivisual-visualcontentalttext"></a>
The alt text for the visual.  
*Required*: No  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `1024`  
*Update requires*: [No interruption](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)

`VisualId`  <a name="cfn-quicksight-template-kpivisual-visualid"></a>
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](https://docs.amazonaws.cn/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt)