AWS::QuickSight::Template TemplateVersionDefinition

The detailed definition of a template.

Syntax

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

JSON

{
  "AnalysisDefaults" : AnalysisDefaults,
  "CalculatedFields" : [ CalculatedField, ... ],
  "ColumnConfigurations" : [ ColumnConfiguration, ... ],
  "DataSetConfigurations" : [ DataSetConfiguration, ... ],
  "FilterGroups" : [ FilterGroup, ... ],
  "Options" : AssetOptions,
  "ParameterDeclarations" : [ ParameterDeclaration, ... ],
  "Sheets" : [ SheetDefinition, ... ]
}

YAML

  AnalysisDefaults: 
    AnalysisDefaults
  CalculatedFields: 
    - CalculatedField
  ColumnConfigurations: 
    - ColumnConfiguration
  DataSetConfigurations: 
    - DataSetConfiguration
  FilterGroups: 
    - FilterGroup
  Options: 
    AssetOptions
  ParameterDeclarations: 
    - ParameterDeclaration
  Sheets: 
    - SheetDefinition

Properties

AnalysisDefaults

Property description not available.

Required: No

Type: AnalysisDefaults

Update requires: No interruption

CalculatedFields

An array of calculated field definitions for the template.

Required: No

Type: Array of CalculatedField

Minimum: 0

Maximum: 500

Update requires: No interruption

ColumnConfigurations

An array of template-level column configurations. Column configurations are used to set default formatting for a column that's used throughout a template.

Required: No

Type: Array of ColumnConfiguration

Minimum: 0

Maximum: 200

Update requires: No interruption

DataSetConfigurations

An array of dataset configurations. These configurations define the required columns for each dataset used within a template.

Required: Yes

Type: Array of DataSetConfiguration

Minimum: 0

Maximum: 30

Update requires: No interruption

FilterGroups

Filter definitions for a template.

For more information, see Filtering Data in the Amazon QuickSight User Guide.

Required: No

Type: Array of FilterGroup

Minimum: 0

Maximum: 2000

Update requires: No interruption

Options

An array of option definitions for a template.

Required: No

Type: AssetOptions

Update requires: No interruption

ParameterDeclarations

An array of parameter declarations for a template.

Parameters are named variables that can transfer a value for use by an action or an object.

For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.

Required: No

Type: Array of ParameterDeclaration

Minimum: 0

Maximum: 200

Update requires: No interruption

Sheets

An array of sheet definitions for a template.

Required: No

Type: Array of SheetDefinition

Minimum: 0

Maximum: 20

Update requires: No interruption