AWS::QuickSight::Dashboard DashboardPublishOptions - Amazon CloudFormation
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 DashboardPublishOptions

Dashboard publish options:

  • 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.

Syntax

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

Properties

AdHocFilteringOption

Ad hoc (one-time) filtering option.

Required: No

Type: AdHocFilteringOption

Update requires: No interruption

DataPointDrillUpDownOption

The drill-down options of data points in a dashboard.

Required: No

Type: DataPointDrillUpDownOption

Update requires: No interruption

DataPointMenuLabelOption

The data point menu label options of a dashboard.

Required: No

Type: DataPointMenuLabelOption

Update requires: No interruption

DataPointTooltipOption

The data point tool tip options of a dashboard.

Required: No

Type: DataPointTooltipOption

Update requires: No interruption

DataQAEnabledOption

Adds Q&A capabilities to an Quick Sight dashboard. If no topic is linked, Dashboard Q&A uses the data values that are rendered on the dashboard. End users can use Dashboard Q&A to ask for different slices of the data that they see on the dashboard. If a topic is linked, Topic Q&A is used.

Required: No

Type: DataQAEnabledOption

Update requires: No interruption

DataStoriesSharingOption

Data stories sharing option.

Required: No

Type: DataStoriesSharingOption

Update requires: No interruption

ExecutiveSummaryOption

Executive summary option.

Required: No

Type: ExecutiveSummaryOption

Update requires: No interruption

ExportToCSVOption

Export to .csv option.

Required: No

Type: ExportToCSVOption

Update requires: No interruption

ExportWithHiddenFieldsOption

Determines if hidden fields are exported with a dashboard.

Required: No

Type: ExportWithHiddenFieldsOption

Update requires: No interruption

QuickSuiteActionsOption

Determines if Actions in Amazon Quick Suite are enabled in a dashboard.

Required: No

Type: QuickSuiteActionsOption

Update requires: No interruption

SheetControlsOption

Sheet controls option.

Required: No

Type: SheetControlsOption

Update requires: No interruption

SheetLayoutElementMaximizationOption

The sheet layout maximization options of a dashbaord.

Required: No

Type: SheetLayoutElementMaximizationOption

Update requires: No interruption

VisualAxisSortOption

The axis sort options of a dashboard.

Required: No

Type: VisualAxisSortOption

Update requires: No interruption

VisualMenuOption

The menu options of a visual in a dashboard.

Required: No

Type: VisualMenuOption

Update requires: No interruption

VisualPublishOptions

The visual publish options of a visual in a dashboard.

Required: No

Type: DashboardVisualPublishOptions

Update requires: No interruption