Package software.amazon.awscdk.services.quicksight

Interface CfnDashboard.DashboardPublishOptionsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDashboard.DashboardPublishOptionsProperty.Jsii$Proxy

Enclosing class:

CfnDashboard

@Stability(Stable)
public static interface CfnDashboard.DashboardPublishOptionsProperty
extends software.amazon.jsii.JsiiSerializable

Dashboard publish options.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 DashboardPublishOptionsProperty dashboardPublishOptionsProperty = DashboardPublishOptionsProperty.builder()
         .adHocFilteringOption(AdHocFilteringOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .dataPointDrillUpDownOption(DataPointDrillUpDownOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .dataPointMenuLabelOption(DataPointMenuLabelOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .dataPointTooltipOption(DataPointTooltipOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .exportToCsvOption(ExportToCSVOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .exportWithHiddenFieldsOption(ExportWithHiddenFieldsOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .sheetControlsOption(SheetControlsOptionProperty.builder()
                 .visibilityState("visibilityState")
                 .build())
         .sheetLayoutElementMaximizationOption(SheetLayoutElementMaximizationOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .visualAxisSortOption(VisualAxisSortOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .visualMenuOption(VisualMenuOptionProperty.builder()
                 .availabilityStatus("availabilityStatus")
                 .build())
         .visualPublishOptions(DashboardVisualPublishOptionsProperty.builder()
                 .exportHiddenFieldsOption(ExportHiddenFieldsOptionProperty.builder()
                         .availabilityStatus("availabilityStatus")
                         .build())
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDashboard.DashboardPublishOptionsProperty.Builder	A builder for CfnDashboard.DashboardPublishOptionsProperty
static final class	CfnDashboard.DashboardPublishOptionsProperty.Jsii$Proxy	An implementation for CfnDashboard.DashboardPublishOptionsProperty

Method Summary

Modifier and Type	Method	Description
static CfnDashboard.DashboardPublishOptionsProperty.Builder	builder()
default Object	getAdHocFilteringOption()	Ad hoc (one-time) filtering option.
default Object	getDataPointDrillUpDownOption()	The drill-down options of data points in a dashboard.
default Object	getDataPointMenuLabelOption()	The data point menu label options of a dashboard.
default Object	getDataPointTooltipOption()	The data point tool tip options of a dashboard.
default Object	getExportToCsvOption()	Export to .csv option.
default Object	getExportWithHiddenFieldsOption()	Determines if hidden fields are exported with a dashboard.
default Object	getSheetControlsOption()	Sheet controls option.
default Object	getSheetLayoutElementMaximizationOption()	The sheet layout maximization options of a dashbaord.
default Object	getVisualAxisSortOption()	The axis sort options of a dashboard.
default Object	getVisualMenuOption()	The menu options of a visual in a dashboard.
default Object	getVisualPublishOptions()	The visual publish options of a visual in a dashboard.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdHocFilteringOption

@Stability(Stable)
@Nullable
default Object getAdHocFilteringOption()

Ad hoc (one-time) filtering option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-adhocfilteringoption

getDataPointDrillUpDownOption

@Stability(Stable)
@Nullable
default Object getDataPointDrillUpDownOption()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointdrillupdownoption

getDataPointMenuLabelOption

@Stability(Stable)
@Nullable
default Object getDataPointMenuLabelOption()

The data point menu label options of a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointmenulabeloption

getDataPointTooltipOption

@Stability(Stable)
@Nullable
default Object getDataPointTooltipOption()

The data point tool tip options of a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-datapointtooltipoption

getExportToCsvOption

@Stability(Stable)
@Nullable
default Object getExportToCsvOption()

Export to .csv option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exporttocsvoption

getExportWithHiddenFieldsOption

@Stability(Stable)
@Nullable
default Object getExportWithHiddenFieldsOption()

Determines if hidden fields are exported with a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-exportwithhiddenfieldsoption

getSheetControlsOption

@Stability(Stable)
@Nullable
default Object getSheetControlsOption()

Sheet controls option.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetcontrolsoption

getSheetLayoutElementMaximizationOption

@Stability(Stable)
@Nullable
default Object getSheetLayoutElementMaximizationOption()

The sheet layout maximization options of a dashbaord.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-sheetlayoutelementmaximizationoption

getVisualAxisSortOption

@Stability(Stable)
@Nullable
default Object getVisualAxisSortOption()

The axis sort options of a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualaxissortoption

getVisualMenuOption

@Stability(Stable)
@Nullable
default Object getVisualMenuOption()

The menu options of a visual in a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualmenuoption

getVisualPublishOptions

@Stability(Stable)
@Nullable
default Object getVisualPublishOptions()

The visual publish options of a visual in a dashboard.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-dashboardpublishoptions.html#cfn-quicksight-dashboard-dashboardpublishoptions-visualpublishoptions

builder

@Stability(Stable)
static CfnDashboard.DashboardPublishOptionsProperty.Builder builder()

Returns:

a CfnDashboard.DashboardPublishOptionsProperty.Builder of CfnDashboard.DashboardPublishOptionsProperty