AWS::QuickSight::Template InsightVisual

An insight visual.

For more information, see Working with insights in the Amazon QuickSight User Guide.

Syntax

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

JSON

{
  "Actions" : [ VisualCustomAction, ... ],
  "DataSetIdentifier" : String,
  "InsightConfiguration" : InsightConfiguration,
  "Subtitle" : VisualSubtitleLabelOptions,
  "Title" : VisualTitleLabelOptions,
  "VisualId" : String
}

YAML

  Actions: 
    - VisualCustomAction
  DataSetIdentifier: String
  InsightConfiguration: 
    InsightConfiguration
  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

DataSetIdentifier

The dataset that is used in the insight visual.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

InsightConfiguration

The configuration of an insight visual.

Required: No

Type: InsightConfiguration

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