AWS CDK Reference

Appearance

v2.274.0

CfnDashboardProps Struct ​

Properties for defining a CfnDashboard.

Source
Generated code
Type last changed
v2.227.0 · 21 Nov 2025

Example ​

ts
// The generated example for this type would exceed 500 lines,
// and has been elided for readability.

Properties ​

awsAccountIdstringaws_account_idstrawsAccountIdStringAwsAccountIdstringAwsAccountId*stringrequired#
The ID of the AWS account where you want to create the dashboard.
dashboardIdstringdashboard_idstrdashboardIdStringDashboardIdstringDashboardId*stringrequired#
The ID for the dashboard, also added to the IAM policy.
dashboardPublishOptionsIResolvable | CfnDashboard.DashboardPublishOptionsPropertydashboard_publish_optionstyping.Union[IResolvable, DashboardPublishOptionsProperty]dashboardPublishOptionsIResolvableDashboardPublishOptionsIResolvableDashboardPublishOptionsinterface{}#
Options for publishing the dashboard when you create it:.
notes
  • 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.
folderArnsstring[]folder_arnstyping.List[str]folderArnsList<String>FolderArnsstring[]FolderArns*[]*string#
linkEntitiesstring[]link_entitiestyping.List[str]linkEntitiesList<String>LinkEntitiesstring[]LinkEntities*[]*string#
A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
linkSharingConfigurationIResolvable | CfnDashboard.LinkSharingConfigurationPropertylink_sharing_configurationtyping.Union[IResolvable, LinkSharingConfigurationProperty]linkSharingConfigurationIResolvableLinkSharingConfigurationIResolvableLinkSharingConfigurationinterface{}#
A structure that contains the link sharing configurations that you want to apply overrides to.
namestringnamestrnameStringNamestringName*stringrequired#
The display name of the dashboard.
parametersIResolvable | CfnDashboard.ParametersPropertyparameterstyping.Union[IResolvable, ParametersProperty]parametersIResolvableParametersIResolvableParametersinterface{}#
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.

permissionsIResolvable | IResolvable | CfnDashboard.ResourcePermissionProperty[]permissionstyping.Union[IResolvable, typing.List[typing.Union[IResolvable, ResourcePermissionProperty]]]permissionsIResolvablePermissionsIResolvablePermissionsinterface{}#
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.

sourceEntityIResolvable | CfnDashboard.DashboardSourceEntityPropertysource_entitytyping.Union[IResolvable, DashboardSourceEntityProperty]sourceEntityIResolvableSourceEntityIResolvableSourceEntityinterface{}#
The entity that you are using as a source when you create the dashboard.
notes

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.

tagsCfnTag[]tagstyping.List[CfnTag]tagsList<CfnTag>TagsCfnTag[]Tags*[]CfnTag#
Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
themeArnstring | IThemeReftheme_arntyping.Union[str, IThemeRef]themeArnStringThemeArnstringThemeArninterface{}#
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.

validationStrategyIResolvable | CfnDashboard.ValidationStrategyPropertyvalidation_strategytyping.Union[IResolvable, ValidationStrategyProperty]validationStrategyIResolvableValidationStrategyIResolvableValidationStrategyinterface{}#
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.

versionDescriptionstringversion_descriptionstrversionDescriptionStringVersionDescriptionstringVersionDescription*string#
A description for the first version of the dashboard being created.