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 Amazon QuickSight that identifies Amazon QuickSight reports, created from analyses. You can share Amazon 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 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
, "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
-
The ID of the Amazon account where you want to create the dashboard.
Required: Yes
Type: String
Minimum:
12
Maximum:
12
Pattern:
^[0-9]{12}$
Update requires: Replacement
DashboardId
-
The ID for the dashboard, also added to the IAM policy.
Required: Yes
Type: String
Minimum:
1
Maximum:
512
Pattern:
[\w\-]+
Update requires: Replacement
DashboardPublishOptions
-
Options for publishing the dashboard when you create it:
-
AvailabilityStatus
forAdHocFilteringOption
- This status can be eitherENABLED
orDISABLED
. When this is set toDISABLED
, Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option isENABLED
by default. -
AvailabilityStatus
forExportToCSVOption
- This status can be eitherENABLED
orDISABLED
. The visual option to export data to .CSV format isn't enabled when this is set toDISABLED
. This option isENABLED
by default. -
VisibilityState
forSheetControlsOption
- This visibility state can be eitherCOLLAPSED
orEXPANDED
. This option isCOLLAPSED
by default.
Required: No
Type: DashboardPublishOptions
Update requires: No interruption
-
Name
-
The display name of the dashboard.
Required: No
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: List of ResourcePermission
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 aSourceTemplate
entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using theCreateTemplate
API operation. ForSourceTemplate
, specify the Amazon Resource Name (ARN) of the source template. TheSourceTemplate
ARN can contain any Amazon account; and any QuickSight-supported Amazon Web Services Region.Use the
DataSetReferences
entity withinSourceTemplate
to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.Required: Yes
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: List of Tag
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
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.
Version
-
The version of the dashboard.
Version.Arn
Property description not available.
Version.CreatedTime
Property description not available.
Version.DataSetArns
Property description not available.
Version.Description
Property description not available.
Version.Errors
Property description not available.
Version.Sheets
Property description not available.
Version.SourceEntityArn
Property description not available.
Version.Status
Property description not available.
Version.ThemeArn
Property description not available.
Version.VersionNumber
Property description not available.