Class: AWSCDK::QuickSight::CfnDashboard::DashboardPublishOptionsProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.rb

Overview

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.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(ad_hoc_filtering_option: nil, data_point_drill_up_down_option: nil, data_point_menu_label_option: nil, data_point_tooltip_option: nil, data_qa_enabled_option: nil, data_stories_sharing_option: nil, executive_summary_option: nil, export_to_csv_option: nil, export_with_hidden_fields_option: nil, quick_suite_actions_option: nil, sheet_controls_option: nil, sheet_layout_element_maximization_option: nil, visual_axis_sort_option: nil, visual_menu_option: nil, visual_publish_options: nil) ⇒ DashboardPublishOptionsProperty

Returns a new instance of DashboardPublishOptionsProperty.

Parameters:



6119
6120
6121
6122
6123
6124
6125
6126
6127
6128
6129
6130
6131
6132
6133
6134
6135
6136
6137
6138
6139
6140
6141
6142
6143
6144
6145
6146
6147
6148
6149
6150
 
# File 'quick_sight/cfn_dashboard.rb', line 6119

def initialize(ad_hoc_filtering_option: nil, data_point_drill_up_down_option: nil, data_point_menu_label_option: nil, data_point_tooltip_option: nil, data_qa_enabled_option: nil, data_stories_sharing_option: nil, executive_summary_option: nil, export_to_csv_option: nil, export_with_hidden_fields_option: nil, quick_suite_actions_option: nil, sheet_controls_option: nil, sheet_layout_element_maximization_option: nil, visual_axis_sort_option: nil, visual_menu_option: nil, visual_publish_options: nil)
  @ad_hoc_filtering_option = ad_hoc_filtering_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::AdHocFilteringOptionProperty.new(**ad_hoc_filtering_option.transform_keys(&:to_sym)) : ad_hoc_filtering_option
  Jsii::Type.check_type(@ad_hoc_filtering_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5BZEhvY0ZpbHRlcmluZ09wdGlvblByb3BlcnR5In1dfX0=")), "adHocFilteringOption") unless @ad_hoc_filtering_option.nil?
  @data_point_drill_up_down_option = data_point_drill_up_down_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataPointDrillUpDownOptionProperty.new(**data_point_drill_up_down_option.transform_keys(&:to_sym)) : data_point_drill_up_down_option
  Jsii::Type.check_type(@data_point_drill_up_down_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhUG9pbnREcmlsbFVwRG93bk9wdGlvblByb3BlcnR5In1dfX0=")), "dataPointDrillUpDownOption") unless @data_point_drill_up_down_option.nil?
  @data_point_menu_label_option = data_point_menu_label_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataPointMenuLabelOptionProperty.new(**data_point_menu_label_option.transform_keys(&:to_sym)) : data_point_menu_label_option
  Jsii::Type.check_type(@data_point_menu_label_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhUG9pbnRNZW51TGFiZWxPcHRpb25Qcm9wZXJ0eSJ9XX19")), "dataPointMenuLabelOption") unless @data_point_menu_label_option.nil?
  @data_point_tooltip_option = data_point_tooltip_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataPointTooltipOptionProperty.new(**data_point_tooltip_option.transform_keys(&:to_sym)) : data_point_tooltip_option
  Jsii::Type.check_type(@data_point_tooltip_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhUG9pbnRUb29sdGlwT3B0aW9uUHJvcGVydHkifV19fQ==")), "dataPointTooltipOption") unless @data_point_tooltip_option.nil?
  @data_qa_enabled_option = data_qa_enabled_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataQAEnabledOptionProperty.new(**data_qa_enabled_option.transform_keys(&:to_sym)) : data_qa_enabled_option
  Jsii::Type.check_type(@data_qa_enabled_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhUUFFbmFibGVkT3B0aW9uUHJvcGVydHkifV19fQ==")), "dataQaEnabledOption") unless @data_qa_enabled_option.nil?
  @data_stories_sharing_option = data_stories_sharing_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DataStoriesSharingOptionProperty.new(**data_stories_sharing_option.transform_keys(&:to_sym)) : data_stories_sharing_option
  Jsii::Type.check_type(@data_stories_sharing_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXRhU3Rvcmllc1NoYXJpbmdPcHRpb25Qcm9wZXJ0eSJ9XX19")), "dataStoriesSharingOption") unless @data_stories_sharing_option.nil?
  @executive_summary_option = executive_summary_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ExecutiveSummaryOptionProperty.new(**executive_summary_option.transform_keys(&:to_sym)) : executive_summary_option
  Jsii::Type.check_type(@executive_summary_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5FeGVjdXRpdmVTdW1tYXJ5T3B0aW9uUHJvcGVydHkifV19fQ==")), "executiveSummaryOption") unless @executive_summary_option.nil?
  @export_to_csv_option = export_to_csv_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ExportToCSVOptionProperty.new(**export_to_csv_option.transform_keys(&:to_sym)) : export_to_csv_option
  Jsii::Type.check_type(@export_to_csv_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5FeHBvcnRUb0NTVk9wdGlvblByb3BlcnR5In1dfX0=")), "exportToCsvOption") unless @export_to_csv_option.nil?
  @export_with_hidden_fields_option = export_with_hidden_fields_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ExportWithHiddenFieldsOptionProperty.new(**export_with_hidden_fields_option.transform_keys(&:to_sym)) : export_with_hidden_fields_option
  Jsii::Type.check_type(@export_with_hidden_fields_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5FeHBvcnRXaXRoSGlkZGVuRmllbGRzT3B0aW9uUHJvcGVydHkifV19fQ==")), "exportWithHiddenFieldsOption") unless @export_with_hidden_fields_option.nil?
  @quick_suite_actions_option = quick_suite_actions_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::QuickSuiteActionsOptionProperty.new(**quick_suite_actions_option.transform_keys(&:to_sym)) : quick_suite_actions_option
  Jsii::Type.check_type(@quick_suite_actions_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5RdWlja1N1aXRlQWN0aW9uc09wdGlvblByb3BlcnR5In1dfX0=")), "quickSuiteActionsOption") unless @quick_suite_actions_option.nil?
  @sheet_controls_option = sheet_controls_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SheetControlsOptionProperty.new(**sheet_controls_option.transform_keys(&:to_sym)) : sheet_controls_option
  Jsii::Type.check_type(@sheet_controls_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TaGVldENvbnRyb2xzT3B0aW9uUHJvcGVydHkifV19fQ==")), "sheetControlsOption") unless @sheet_controls_option.nil?
  @sheet_layout_element_maximization_option = sheet_layout_element_maximization_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::SheetLayoutElementMaximizationOptionProperty.new(**sheet_layout_element_maximization_option.transform_keys(&:to_sym)) : sheet_layout_element_maximization_option
  Jsii::Type.check_type(@sheet_layout_element_maximization_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5TaGVldExheW91dEVsZW1lbnRNYXhpbWl6YXRpb25PcHRpb25Qcm9wZXJ0eSJ9XX19")), "sheetLayoutElementMaximizationOption") unless @sheet_layout_element_maximization_option.nil?
  @visual_axis_sort_option = visual_axis_sort_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualAxisSortOptionProperty.new(**visual_axis_sort_option.transform_keys(&:to_sym)) : visual_axis_sort_option
  Jsii::Type.check_type(@visual_axis_sort_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxBeGlzU29ydE9wdGlvblByb3BlcnR5In1dfX0=")), "visualAxisSortOption") unless @visual_axis_sort_option.nil?
  @visual_menu_option = visual_menu_option.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualMenuOptionProperty.new(**visual_menu_option.transform_keys(&:to_sym)) : visual_menu_option
  Jsii::Type.check_type(@visual_menu_option, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxNZW51T3B0aW9uUHJvcGVydHkifV19fQ==")), "visualMenuOption") unless @visual_menu_option.nil?
  @visual_publish_options = visual_publish_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::DashboardVisualPublishOptionsProperty.new(**visual_publish_options.transform_keys(&:to_sym)) : visual_publish_options
  Jsii::Type.check_type(@visual_publish_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5EYXNoYm9hcmRWaXN1YWxQdWJsaXNoT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "visualPublishOptions") unless @visual_publish_options.nil?
end

Instance Attribute Details

#ad_hoc_filtering_option ⇒ AWSCDK::IResolvable, ... (readonly)

Ad hoc (one-time) filtering option.

Returns:

See Also:



6156
6157
6158
 
# File 'quick_sight/cfn_dashboard.rb', line 6156

def ad_hoc_filtering_option
  @ad_hoc_filtering_option
end

#data_point_drill_up_down_option ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



6161
6162
6163
 
# File 'quick_sight/cfn_dashboard.rb', line 6161

def data_point_drill_up_down_option
  @data_point_drill_up_down_option
end

#data_point_menu_label_option ⇒ AWSCDK::IResolvable, ... (readonly)

The data point menu label options of a dashboard.

Returns:

See Also:



6166
6167
6168
 
# File 'quick_sight/cfn_dashboard.rb', line 6166

def data_point_menu_label_option
  @data_point_menu_label_option
end

#data_point_tooltip_option ⇒ AWSCDK::IResolvable, ... (readonly)

The data point tool tip options of a dashboard.

Returns:

See Also:



6171
6172
6173
 
# File 'quick_sight/cfn_dashboard.rb', line 6171

def data_point_tooltip_option
  @data_point_tooltip_option
end

#data_qa_enabled_option ⇒ AWSCDK::IResolvable, ... (readonly)

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.

Returns:

See Also:



6178
6179
6180
 
# File 'quick_sight/cfn_dashboard.rb', line 6178

def data_qa_enabled_option
  @data_qa_enabled_option
end

#data_stories_sharing_option ⇒ AWSCDK::IResolvable, ... (readonly)

Data stories sharing option.

Returns:

See Also:



6183
6184
6185
 
# File 'quick_sight/cfn_dashboard.rb', line 6183

def data_stories_sharing_option
  @data_stories_sharing_option
end

#executive_summary_option ⇒ AWSCDK::IResolvable, ... (readonly)

Executive summary option.

Returns:

See Also:



6188
6189
6190
 
# File 'quick_sight/cfn_dashboard.rb', line 6188

def executive_summary_option
  @executive_summary_option
end

#export_to_csv_option ⇒ AWSCDK::IResolvable, ... (readonly)

Export to .csv option.

Returns:

See Also:



6193
6194
6195
 
# File 'quick_sight/cfn_dashboard.rb', line 6193

def export_to_csv_option
  @export_to_csv_option
end

#export_with_hidden_fields_option ⇒ AWSCDK::IResolvable, ... (readonly)

Determines if hidden fields are exported with a dashboard.

Returns:

See Also:



6198
6199
6200
 
# File 'quick_sight/cfn_dashboard.rb', line 6198

def export_with_hidden_fields_option
  @export_with_hidden_fields_option
end

#quick_suite_actions_option ⇒ AWSCDK::IResolvable, ... (readonly)

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

Returns:

See Also:



6203
6204
6205
 
# File 'quick_sight/cfn_dashboard.rb', line 6203

def quick_suite_actions_option
  @quick_suite_actions_option
end

#sheet_controls_option ⇒ AWSCDK::IResolvable, ... (readonly)

Sheet controls option.

Returns:

See Also:



6208
6209
6210
 
# File 'quick_sight/cfn_dashboard.rb', line 6208

def sheet_controls_option
  @sheet_controls_option
end

#sheet_layout_element_maximization_option ⇒ AWSCDK::IResolvable, ... (readonly)

The sheet layout maximization options of a dashbaord.

Returns:

See Also:



6213
6214
6215
 
# File 'quick_sight/cfn_dashboard.rb', line 6213

def sheet_layout_element_maximization_option
  @sheet_layout_element_maximization_option
end

#visual_axis_sort_option ⇒ AWSCDK::IResolvable, ... (readonly)

The axis sort options of a dashboard.

Returns:

See Also:



6218
6219
6220
 
# File 'quick_sight/cfn_dashboard.rb', line 6218

def visual_axis_sort_option
  @visual_axis_sort_option
end

#visual_menu_option ⇒ AWSCDK::IResolvable, ... (readonly)

The menu options of a visual in a dashboard.

Returns:

See Also:



6223
6224
6225
 
# File 'quick_sight/cfn_dashboard.rb', line 6223

def visual_menu_option
  @visual_menu_option
end

#visual_publish_options ⇒ AWSCDK::IResolvable, ... (readonly)

The visual publish options of a visual in a dashboard.

Returns:

See Also:



6228
6229
6230
 
# File 'quick_sight/cfn_dashboard.rb', line 6228

def visual_publish_options
  @visual_publish_options
end

Class Method Details

.jsii_properties ⇒ Object 



6230
6231
6232
6233
6234
6235
6236
6237
6238
6239
6240
6241
6242
6243
6244
6245
6246
6247
6248
 
# File 'quick_sight/cfn_dashboard.rb', line 6230

def self.jsii_properties
  {
    :ad_hoc_filtering_option => "adHocFilteringOption",
    :data_point_drill_up_down_option => "dataPointDrillUpDownOption",
    :data_point_menu_label_option => "dataPointMenuLabelOption",
    :data_point_tooltip_option => "dataPointTooltipOption",
    :data_qa_enabled_option => "dataQaEnabledOption",
    :data_stories_sharing_option => "dataStoriesSharingOption",
    :executive_summary_option => "executiveSummaryOption",
    :export_to_csv_option => "exportToCsvOption",
    :export_with_hidden_fields_option => "exportWithHiddenFieldsOption",
    :quick_suite_actions_option => "quickSuiteActionsOption",
    :sheet_controls_option => "sheetControlsOption",
    :sheet_layout_element_maximization_option => "sheetLayoutElementMaximizationOption",
    :visual_axis_sort_option => "visualAxisSortOption",
    :visual_menu_option => "visualMenuOption",
    :visual_publish_options => "visualPublishOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



6250
6251
6252
6253
6254
6255
6256
6257
6258
6259
6260
6261
6262
6263
6264
6265
6266
6267
6268
6269
6270
 
# File 'quick_sight/cfn_dashboard.rb', line 6250

def to_jsii
  result = {}
  result.merge!({
    "adHocFilteringOption" => @ad_hoc_filtering_option,
    "dataPointDrillUpDownOption" => @data_point_drill_up_down_option,
    "dataPointMenuLabelOption" => @data_point_menu_label_option,
    "dataPointTooltipOption" => @data_point_tooltip_option,
    "dataQaEnabledOption" => @data_qa_enabled_option,
    "dataStoriesSharingOption" => @data_stories_sharing_option,
    "executiveSummaryOption" => @executive_summary_option,
    "exportToCsvOption" => @export_to_csv_option,
    "exportWithHiddenFieldsOption" => @export_with_hidden_fields_option,
    "quickSuiteActionsOption" => @quick_suite_actions_option,
    "sheetControlsOption" => @sheet_controls_option,
    "sheetLayoutElementMaximizationOption" => @sheet_layout_element_maximization_option,
    "visualAxisSortOption" => @visual_axis_sort_option,
    "visualMenuOption" => @visual_menu_option,
    "visualPublishOptions" => @visual_publish_options,
  })
  result.compact
end