Class: AWSCDK::QuickSight::CfnTemplate::FilterControlProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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:



9541
9542
9543
9544
9545
9546
9547
9548
9549
9550
9551
9552
9553
9554
9555
9556
9557
9558
 
# File 'quick_sight/cfn_template.rb', line 9541

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::CfnTemplate::FilterCrossSheetControlProperty.new(**cross_sheet.transform_keys(&:to_sym)) : cross_sheet
  Jsii::Type.check_type(@cross_sheet, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlckNyb3NzU2hlZXRDb250cm9sUHJvcGVydHkifV19fQ==")), "crossSheet") unless @cross_sheet.nil?
  @date_time_picker = date_time_picker.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterDateTimePickerControlProperty.new(**date_time_picker.transform_keys(&:to_sym)) : date_time_picker
  Jsii::Type.check_type(@date_time_picker, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlckRhdGVUaW1lUGlja2VyQ29udHJvbFByb3BlcnR5In1dfX0=")), "dateTimePicker") unless @date_time_picker.nil?
  @dropdown = dropdown.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterDropDownControlProperty.new(**dropdown.transform_keys(&:to_sym)) : dropdown
  Jsii::Type.check_type(@dropdown, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlckRyb3BEb3duQ29udHJvbFByb3BlcnR5In1dfX0=")), "dropdown") unless @dropdown.nil?
  @list = list.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterListControlProperty.new(**list.transform_keys(&:to_sym)) : list
  Jsii::Type.check_type(@list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlckxpc3RDb250cm9sUHJvcGVydHkifV19fQ==")), "list") unless @list.nil?
  @relative_date_time = relative_date_time.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterRelativeDateTimeControlProperty.new(**relative_date_time.transform_keys(&:to_sym)) : relative_date_time
  Jsii::Type.check_type(@relative_date_time, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclJlbGF0aXZlRGF0ZVRpbWVDb250cm9sUHJvcGVydHkifV19fQ==")), "relativeDateTime") unless @relative_date_time.nil?
  @slider = slider.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterSliderControlProperty.new(**slider.transform_keys(&:to_sym)) : slider
  Jsii::Type.check_type(@slider, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclNsaWRlckNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "slider") unless @slider.nil?
  @text_area = text_area.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterTextAreaControlProperty.new(**text_area.transform_keys(&:to_sym)) : text_area
  Jsii::Type.check_type(@text_area, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclRleHRBcmVhQ29udHJvbFByb3BlcnR5In1dfX0=")), "textArea") unless @text_area.nil?
  @text_field = text_field.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterTextFieldControlProperty.new(**text_field.transform_keys(&:to_sym)) : text_field
  Jsii::Type.check_type(@text_field, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclRleHRGaWVsZENvbnRyb2xQcm9wZXJ0eSJ9XX19")), "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:



9566
9567
9568
 
# File 'quick_sight/cfn_template.rb', line 9566

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:



9571
9572
9573
 
# File 'quick_sight/cfn_template.rb', line 9571

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:



9576
9577
9578
 
# File 'quick_sight/cfn_template.rb', line 9576

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:



9583
9584
9585
 
# File 'quick_sight/cfn_template.rb', line 9583

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:



9588
9589
9590
 
# File 'quick_sight/cfn_template.rb', line 9588

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:



9595
9596
9597
 
# File 'quick_sight/cfn_template.rb', line 9595

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:



9600
9601
9602
 
# File 'quick_sight/cfn_template.rb', line 9600

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:



9605
9606
9607
 
# File 'quick_sight/cfn_template.rb', line 9605

def text_field
  @text_field
end

Class Method Details

.jsii_properties ⇒ Object 



9607
9608
9609
9610
9611
9612
9613
9614
9615
9616
9617
9618
 
# File 'quick_sight/cfn_template.rb', line 9607

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 



9620
9621
9622
9623
9624
9625
9626
9627
9628
9629
9630
9631
9632
9633
 
# File 'quick_sight/cfn_template.rb', line 9620

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