L1 ConstructAWS::QuickSight::Dashboard

CfnDashboard

Creates a dashboard from a template. To first create a template, see the `CreateTemplate` API operation. A dashboard is an entity in Quick that identifies Quick reports, created from analyses. You can share Quick 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 .

Import

import { CfnDashboard } from 'aws-cdk-lib/aws-quicksight';

Or use the module namespace:

import * as quicksight from 'aws-cdk-lib/aws-quicksight';
// quicksight.CfnDashboard

Properties

Configuration passed to the constructor as CfnDashboardProps.

awsAccountIdRequired

string

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

dashboardIdRequired

string

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

nameRequired

string

The display name of the dashboard.

dashboardPublishOptionsOptional

IResolvable | DashboardPublishOptionsProperty

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.

definitionOptional

IResolvable | DashboardVersionDefinitionProperty

folderArnsOptional

string[]

linkEntitiesOptional

string[]

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

linkSharingConfigurationOptional

IResolvable | LinkSharingConfigurationProperty

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

parametersOptional

IResolvable | ParametersProperty

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.

permissionsOptional

IResolvable | IResolvable | ResourcePermissionProperty[]

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.

sourceEntityOptional

IResolvable | DashboardSourceEntityProperty

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 `SourceTemplate` ARN can contain any AWS account; and any QuickSight-supported AWS 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.

tagsOptional

CfnTag[]

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

themeArnOptional

string | IThemeRef

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 AWS account where you create the dashboard.

validationStrategyOptional

IResolvable | ValidationStrategyProperty

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.

versionDescriptionOptional

string

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

CloudFormation Resource

This L1 construct maps directly to the following CloudFormation resource type.

AWS::QuickSight::DashboardView in CloudFormation Explorer

Learn AWS the Practical Way

Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.

Subscribe to Newsletter

Quick Facts

LevelL1 (CloudFormation)

Moduleaws-quicksight

CFN TypeAWS::QuickSight::Dashboard

Properties15

Related Constructs

Explore This Service

External Links

CDK API Documentation