AWS CDK Reference

Appearance

v2.274.0

DashboardPublishOptionsProperty Struct ​

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.
Source
Generated code
Type last changed
v2.220.0 · 14 Oct 2025

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_quicksight as quicksight } from 'aws-cdk-lib';
const dashboardPublishOptionsProperty: quicksight.CfnDashboard.DashboardPublishOptionsProperty = {
  adHocFilteringOption: {
    availabilityStatus: 'availabilityStatus',
  },
  dataPointDrillUpDownOption: {
    availabilityStatus: 'availabilityStatus',
  },
  dataPointMenuLabelOption: {
    availabilityStatus: 'availabilityStatus',
  },
  dataPointTooltipOption: {
    availabilityStatus: 'availabilityStatus',
  },
  dataQaEnabledOption: {
    availabilityStatus: 'availabilityStatus',
  },
  dataStoriesSharingOption: {
    availabilityStatus: 'availabilityStatus',
  },
  executiveSummaryOption: {
    availabilityStatus: 'availabilityStatus',
  },
  exportToCsvOption: {
    availabilityStatus: 'availabilityStatus',
  },
  exportWithHiddenFieldsOption: {
    availabilityStatus: 'availabilityStatus',
  },
  quickSuiteActionsOption: {
    availabilityStatus: 'availabilityStatus',
  },
  sheetControlsOption: {
    visibilityState: 'visibilityState',
  },
  sheetLayoutElementMaximizationOption: {
    availabilityStatus: 'availabilityStatus',
  },
  visualAxisSortOption: {
    availabilityStatus: 'availabilityStatus',
  },
  visualMenuOption: {
    availabilityStatus: 'availabilityStatus',
  },
  visualPublishOptions: {
    exportHiddenFieldsOption: {
      availabilityStatus: 'availabilityStatus',
    },
  },
};

Properties ​

adHocFilteringOptionoptionalIResolvable | CfnDashboard.AdHocFilteringOptionPropertyad_hoc_filtering_optionoptionaltyping.Union[IResolvable, AdHocFilteringOptionProperty]adHocFilteringOptionoptionalIResolvableAdHocFilteringOptionoptionalIResolvableAdHocFilteringOptionoptionalinterface{}#
Ad hoc (one-time) filtering option.
dataPointDrillUpDownOptionoptionalIResolvable | CfnDashboard.DataPointDrillUpDownOptionPropertydata_point_drill_up_down_optionoptionaltyping.Union[IResolvable, DataPointDrillUpDownOptionProperty]dataPointDrillUpDownOptionoptionalIResolvableDataPointDrillUpDownOptionoptionalIResolvableDataPointDrillUpDownOptionoptionalinterface{}#
The drill-down options of data points in a dashboard.
dataPointMenuLabelOptionoptionalIResolvable | CfnDashboard.DataPointMenuLabelOptionPropertydata_point_menu_label_optionoptionaltyping.Union[IResolvable, DataPointMenuLabelOptionProperty]dataPointMenuLabelOptionoptionalIResolvableDataPointMenuLabelOptionoptionalIResolvableDataPointMenuLabelOptionoptionalinterface{}#
The data point menu label options of a dashboard.
dataPointTooltipOptionoptionalIResolvable | CfnDashboard.DataPointTooltipOptionPropertydata_point_tooltip_optionoptionaltyping.Union[IResolvable, DataPointTooltipOptionProperty]dataPointTooltipOptionoptionalIResolvableDataPointTooltipOptionoptionalIResolvableDataPointTooltipOptionoptionalinterface{}#
The data point tool tip options of a dashboard.
dataQaEnabledOptionoptionalIResolvable | CfnDashboard.DataQAEnabledOptionPropertydata_qa_enabled_optionoptionaltyping.Union[IResolvable, DataQAEnabledOptionProperty]dataQaEnabledOptionoptionalIResolvableDataQaEnabledOptionoptionalIResolvableDataQaEnabledOptionoptionalinterface{}#
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.

dataStoriesSharingOptionoptionalIResolvable | CfnDashboard.DataStoriesSharingOptionPropertydata_stories_sharing_optionoptionaltyping.Union[IResolvable, DataStoriesSharingOptionProperty]dataStoriesSharingOptionoptionalIResolvableDataStoriesSharingOptionoptionalIResolvableDataStoriesSharingOptionoptionalinterface{}#
Data stories sharing option.
executiveSummaryOptionoptionalIResolvable | CfnDashboard.ExecutiveSummaryOptionPropertyexecutive_summary_optionoptionaltyping.Union[IResolvable, ExecutiveSummaryOptionProperty]executiveSummaryOptionoptionalIResolvableExecutiveSummaryOptionoptionalIResolvableExecutiveSummaryOptionoptionalinterface{}#
Executive summary option.
exportToCsvOptionoptionalIResolvable | CfnDashboard.ExportToCSVOptionPropertyexport_to_csv_optionoptionaltyping.Union[IResolvable, ExportToCSVOptionProperty]exportToCsvOptionoptionalIResolvableExportToCsvOptionoptionalIResolvableExportToCsvOptionoptionalinterface{}#
Export to .csv option.
exportWithHiddenFieldsOptionoptionalIResolvable | CfnDashboard.ExportWithHiddenFieldsOptionPropertyexport_with_hidden_fields_optionoptionaltyping.Union[IResolvable, ExportWithHiddenFieldsOptionProperty]exportWithHiddenFieldsOptionoptionalIResolvableExportWithHiddenFieldsOptionoptionalIResolvableExportWithHiddenFieldsOptionoptionalinterface{}#
Determines if hidden fields are exported with a dashboard.
quickSuiteActionsOptionoptionalIResolvable | CfnDashboard.QuickSuiteActionsOptionPropertyquick_suite_actions_optionoptionaltyping.Union[IResolvable, QuickSuiteActionsOptionProperty]quickSuiteActionsOptionoptionalIResolvableQuickSuiteActionsOptionoptionalIResolvableQuickSuiteActionsOptionoptionalinterface{}#
Determines if Actions in Amazon Quick Suite are enabled in a dashboard.
sheetControlsOptionoptionalIResolvable | CfnDashboard.SheetControlsOptionPropertysheet_controls_optionoptionaltyping.Union[IResolvable, SheetControlsOptionProperty]sheetControlsOptionoptionalIResolvableSheetControlsOptionoptionalIResolvableSheetControlsOptionoptionalinterface{}#
Sheet controls option.
sheetLayoutElementMaximizationOptionoptionalIResolvable | CfnDashboard.SheetLayoutElementMaximizationOptionPropertysheet_layout_element_maximization_optionoptionaltyping.Union[IResolvable, SheetLayoutElementMaximizationOptionProperty]sheetLayoutElementMaximizationOptionoptionalIResolvableSheetLayoutElementMaximizationOptionoptionalIResolvableSheetLayoutElementMaximizationOptionoptionalinterface{}#
The sheet layout maximization options of a dashbaord.
visualAxisSortOptionoptionalIResolvable | CfnDashboard.VisualAxisSortOptionPropertyvisual_axis_sort_optionoptionaltyping.Union[IResolvable, VisualAxisSortOptionProperty]visualAxisSortOptionoptionalIResolvableVisualAxisSortOptionoptionalIResolvableVisualAxisSortOptionoptionalinterface{}#
The axis sort options of a dashboard.
visualMenuOptionoptionalIResolvable | CfnDashboard.VisualMenuOptionPropertyvisual_menu_optionoptionaltyping.Union[IResolvable, VisualMenuOptionProperty]visualMenuOptionoptionalIResolvableVisualMenuOptionoptionalIResolvableVisualMenuOptionoptionalinterface{}#
The menu options of a visual in a dashboard.
visualPublishOptionsoptionalIResolvable | CfnDashboard.DashboardVisualPublishOptionsPropertyvisual_publish_optionsoptionaltyping.Union[IResolvable, DashboardVisualPublishOptionsProperty]visualPublishOptionsoptionalIResolvableVisualPublishOptionsoptionalIResolvableVisualPublishOptionsoptionalinterface{}#
The visual publish options of a visual in a dashboard.