Class: AWSCDK::QuickSight::CfnDashboard::FilterControlProperty

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

Overview

The control of a filter that is used to interact with a dashboard or an analysis.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cross_sheet: nil, date_time_picker: nil, dropdown: nil, list: nil, relative_date_time: nil, slider: nil, text_area: nil, text_field: nil) ⇒ FilterControlProperty

Returns a new instance of FilterControlProperty.

Parameters:



10486
10487
10488
10489
10490
10491
10492
10493
10494
10495
10496
10497
10498
10499
10500
10501
10502
10503
 
# File 'quick_sight/cfn_dashboard.rb', line 10486

def initialize(cross_sheet: nil, date_time_picker: nil, dropdown: nil, list: nil, relative_date_time: nil, slider: nil, text_area: nil, text_field: nil)
  @cross_sheet = cross_sheet.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterCrossSheetControlProperty.new(**cross_sheet.transform_keys(&:to_sym)) : cross_sheet
  Jsii::Type.check_type(@cross_sheet, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJDcm9zc1NoZWV0Q29udHJvbFByb3BlcnR5In1dfX0=")), "crossSheet") unless @cross_sheet.nil?
  @date_time_picker = date_time_picker.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterDateTimePickerControlProperty.new(**date_time_picker.transform_keys(&:to_sym)) : date_time_picker
  Jsii::Type.check_type(@date_time_picker, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJEYXRlVGltZVBpY2tlckNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "dateTimePicker") unless @date_time_picker.nil?
  @dropdown = dropdown.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterDropDownControlProperty.new(**dropdown.transform_keys(&:to_sym)) : dropdown
  Jsii::Type.check_type(@dropdown, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJEcm9wRG93bkNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "dropdown") unless @dropdown.nil?
  @list = list.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterListControlProperty.new(**list.transform_keys(&:to_sym)) : list
  Jsii::Type.check_type(@list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJMaXN0Q29udHJvbFByb3BlcnR5In1dfX0=")), "list") unless @list.nil?
  @relative_date_time = relative_date_time.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterRelativeDateTimeControlProperty.new(**relative_date_time.transform_keys(&:to_sym)) : relative_date_time
  Jsii::Type.check_type(@relative_date_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJSZWxhdGl2ZURhdGVUaW1lQ29udHJvbFByb3BlcnR5In1dfX0=")), "relativeDateTime") unless @relative_date_time.nil?
  @slider = slider.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterSliderControlProperty.new(**slider.transform_keys(&:to_sym)) : slider
  Jsii::Type.check_type(@slider, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJTbGlkZXJDb250cm9sUHJvcGVydHkifV19fQ==")), "slider") unless @slider.nil?
  @text_area = text_area.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterTextAreaControlProperty.new(**text_area.transform_keys(&:to_sym)) : text_area
  Jsii::Type.check_type(@text_area, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJUZXh0QXJlYUNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "textArea") unless @text_area.nil?
  @text_field = text_field.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::FilterTextFieldControlProperty.new(**text_field.transform_keys(&:to_sym)) : text_field
  Jsii::Type.check_type(@text_field, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5GaWx0ZXJUZXh0RmllbGRDb250cm9sUHJvcGVydHkifV19fQ==")), "textField") unless @text_field.nil?
end

Instance Attribute Details

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

A control from a filter that is scoped across more than one sheet.

This represents your filter control on a sheet

Returns:

See Also:



10511
10512
10513
 
# File 'quick_sight/cfn_dashboard.rb', line 10511

def cross_sheet
  @cross_sheet
end

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

A control from a date filter that is used to specify date and time.

Returns:

See Also:



10516
10517
10518
 
# File 'quick_sight/cfn_dashboard.rb', line 10516

def date_time_picker
  @date_time_picker
end

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

A control to display a dropdown list with buttons that are used to select a single value.

Returns:

See Also:



10521
10522
10523
 
# File 'quick_sight/cfn_dashboard.rb', line 10521

def dropdown
  @dropdown
end

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

A control to display a list of buttons or boxes.

This is used to select either a single value or multiple values.

Returns:

See Also:



10528
10529
10530
 
# File 'quick_sight/cfn_dashboard.rb', line 10528

def list
  @list
end

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

A control from a date filter that is used to specify the relative date.

Returns:

See Also:



10533
10534
10535
 
# File 'quick_sight/cfn_dashboard.rb', line 10533

def relative_date_time
  @relative_date_time
end

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

A control to display a horizontal toggle bar.

This is used to change a value by sliding the toggle.

Returns:

See Also:



10540
10541
10542
 
# File 'quick_sight/cfn_dashboard.rb', line 10540

def slider
  @slider
end

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

A control to display a text box that is used to enter multiple entries.

Returns:

See Also:



10545
10546
10547
 
# File 'quick_sight/cfn_dashboard.rb', line 10545

def text_area
  @text_area
end

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

A control to display a text box that is used to enter a single entry.

Returns:

See Also:



10550
10551
10552
 
# File 'quick_sight/cfn_dashboard.rb', line 10550

def text_field
  @text_field
end

Class Method Details

.jsii_properties ⇒ Object 



10552
10553
10554
10555
10556
10557
10558
10559
10560
10561
10562
10563
 
# File 'quick_sight/cfn_dashboard.rb', line 10552

def self.jsii_properties
  {
    :cross_sheet => "crossSheet",
    :date_time_picker => "dateTimePicker",
    :dropdown => "dropdown",
    :list => "list",
    :relative_date_time => "relativeDateTime",
    :slider => "slider",
    :text_area => "textArea",
    :text_field => "textField",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



10565
10566
10567
10568
10569
10570
10571
10572
10573
10574
10575
10576
10577
10578
 
# File 'quick_sight/cfn_dashboard.rb', line 10565

def to_jsii
  result = {}
  result.merge!({
    "crossSheet" => @cross_sheet,
    "dateTimePicker" => @date_time_picker,
    "dropdown" => @dropdown,
    "list" => @list,
    "relativeDateTime" => @relative_date_time,
    "slider" => @slider,
    "textArea" => @text_area,
    "textField" => @text_field,
  })
  result.compact
end