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 QuickSight that identifies QuickSight reports, created from analyses. You can share QuickSight 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 AWS account.

Syntax

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

JSON

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

YAML

Type: AWS::QuickSight::Dashboard
Properties: 
  AwsAccountId: String
  DashboardId: String
  DashboardPublishOptions: 
    DashboardPublishOptions
  Name: String
  Parameters: 
    Parameters
  Permissions: 
    - ResourcePermission
  SourceEntity: 
    DashboardSourceEntity
  Tags: 
    - Tag
  ThemeArn: String
  VersionDescription: String

Properties

AwsAccountId

Not currently supported by AWS CloudFormation.

Required: Yes

Type: String

Update requires: Replacement

DashboardId

Dashboard ID.

Required: Yes

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\w\-]+

Update requires: Replacement

DashboardPublishOptions

Not currently supported by AWS CloudFormation.

Required: No

Type: DashboardPublishOptions

Update requires: No interruption

Name

A display name for the dashboard.

Required: No

Type: String

Minimum: 1

Maximum: 2048

Pattern: [\u0020-\u00FF]+

Update requires: No interruption

Parameters

Not currently supported by AWS CloudFormation.

Required: No

Type: Parameters

Update requires: No interruption

Permissions

Not currently supported by AWS CloudFormation.

Required: No

Type: List of ResourcePermission

Update requires: No interruption

SourceEntity

Not currently supported by AWS CloudFormation.

Required: No

Type: DashboardSourceEntity

Update requires: No interruption

Tags

Not currently supported by AWS CloudFormation.

Required: No

Type: List of Tag

Update requires: No interruption

ThemeArn

The ARN of the theme associated with a version of the dashboard.

Required: No

Type: String

Update requires: No interruption

VersionDescription

Not currently supported by AWS CloudFormation.

Required: No

Type: String

Update requires: No interruption

Return values

Ref

Fn::GetAtt

Arn

Not currently supported by AWS CloudFormation.

CreatedTime

Not currently supported by AWS CloudFormation.

LastPublishedTime

Not currently supported by AWS CloudFormation.

LastUpdatedTime

Not currently supported by AWS CloudFormation.