AWS::QuickSight::Dashboard - Amazon CloudFormation
SyntaxPropertiesReturn values
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

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.

AWS::QuickSight::Dashboard

Creates a dashboard from a template. To first create a template, see the CreateTemplate API operation.

A dashboard is an entity in Quick Suite that identifies Quick Suite reports, created from analyses. You can share Quick Suite dashboards. With the right permissions, you can create scheduled email reports from them. If you have the correct permissions, you can create a dashboard from a template that exists in a different Amazon Web Services account.

Syntax

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

JSON

{
  "Type" : "AWS::QuickSight::Dashboard",
  "Properties" : {
      "AwsAccountId" : String,
      "DashboardId" : String,
      "DashboardPublishOptions" : DashboardPublishOptions,
      "Definition" : DashboardVersionDefinition,
      "FolderArns" : [ String, ... ],
      "LinkEntities" : [ String, ... ],
      "LinkSharingConfiguration" : LinkSharingConfiguration,
      "Name" : String,
      "Parameters" : Parameters,
      "Permissions" : [ ResourcePermission, ... ],
      "SourceEntity" : DashboardSourceEntity,
      "Tags" : [ Tag, ... ],
      "ThemeArn" : String,
      "ValidationStrategy" : ValidationStrategy,
      "VersionDescription" : String
    }
}

Properties

AwsAccountId

The ID of the Amazon account where you want to create the dashboard.

Required: Yes

Type: String

Pattern: ^[0-9]{12}$

Minimum: 12

Maximum: 12

Update requires: Replacement

DashboardId

The ID for the dashboard, also added to the IAM policy.

Required: Yes

Type: String

Pattern: ^[\w\-]+$

Minimum: 1

Maximum: 512

Update requires: Replacement

DashboardPublishOptions

Options for publishing the dashboard when you create it:

  • AvailabilityStatus for AdHocFilteringOption - This status can be either ENABLED or DISABLED. When this is set to DISABLED, Amazon Quick Sight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is ENABLED by default.

  • AvailabilityStatus for ExportToCSVOption - This status can be either ENABLED or DISABLED. The visual option to export data to .CSV format isn't enabled when this is set to DISABLED. This option is ENABLED by default.

  • VisibilityState for SheetControlsOption - This visibility state can be either COLLAPSED or EXPANDED. This option is COLLAPSED by default.

  • AvailabilityStatus for QuickSuiteActionsOption - This status can be either ENABLED or DISABLED. Features related to Actions in Amazon Quick Suite on dashboards are disabled when this is set to DISABLED. This option is DISABLED by default.

  • AvailabilityStatus for ExecutiveSummaryOption - This status can be either ENABLED or DISABLED. The option to build an executive summary is disabled when this is set to DISABLED. This option is ENABLED by default.

  • AvailabilityStatus for DataStoriesSharingOption - This status can be either ENABLED or DISABLED. The option to share a data story is disabled when this is set to DISABLED. This option is ENABLED by default.

Required: No

Type: DashboardPublishOptions

Update requires: No interruption

Definition

Property description not available.

Required: No

Type: DashboardVersionDefinition

Update requires: No interruption

FolderArns

Property description not available.

Required: No

Type: Array of String

Minimum: 0

Maximum: 10

Update requires: No interruption

LinkEntities

A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.

Required: No

Type: Array of String

Minimum: 1 | 0

Maximum: 1024 | 5

Update requires: No interruption

LinkSharingConfiguration

A structure that contains the link sharing configurations that you want to apply overrides to.

Required: No

Type: LinkSharingConfiguration

Update requires: No interruption

Name

The display name of the dashboard.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Update requires: No interruption

Parameters

The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.

Required: No

Type: Parameters

Update requires: No interruption

Permissions

A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.

To specify no permissions, omit the permissions list.

Required: No

Type: Array of ResourcePermission

Minimum: 1

Maximum: 64

Update requires: No interruption

SourceEntity

The entity that you are using as a source when you create the dashboard. In SourceEntity, you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a SourceTemplate entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the CreateTemplate API operation. For SourceTemplate, specify the Amazon Resource Name (ARN) of the source template. The SourceTemplateARN can contain any Amazon account; and any QuickSight-supported Amazon Web Services Region.

Use the DataSetReferences entity within SourceTemplate to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.

Required: No

Type: DashboardSourceEntity

Update requires: No interruption

Tags

Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.

Required: No

Type: Array of Tag

Minimum: 1

Maximum: 200

Update requires: No interruption

ThemeArn

The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same Amazon account where you create the dashboard.

Required: No

Type: String

Update requires: No interruption

ValidationStrategy

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to LENIENT, validation is skipped for specific errors.

Required: No

Type: ValidationStrategy

Update requires: No interruption

VersionDescription

A description for the first version of the dashboard being created.

Required: No

Type: String

Minimum: 1

Maximum: 512

Update requires: No interruption

Return values

Fn::GetAtt

Arn

The Amazon Resource Name (ARN) of the dashboard.

CreatedTime

The time this dashboard version was created.

LastPublishedTime

The time that the dashboard was last published.

LastUpdatedTime

The time that the dashboard was last updated.