Class: AWSCDK::QuickSight::CfnTemplate::FilterDropDownControlProperty

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

Overview

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

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(filter_control_id:, source_filter_id:, title:, cascading_control_configuration: nil, commit_mode: nil, display_options: nil, selectable_values: nil, type: nil) ⇒ FilterDropDownControlProperty

Returns a new instance of FilterDropDownControlProperty.

Parameters:



9791
9792
9793
9794
9795
9796
9797
9798
9799
9800
9801
9802
9803
9804
9805
9806
9807
9808
 
# File 'quick_sight/cfn_template.rb', line 9791

def initialize(filter_control_id:, source_filter_id:, title:, cascading_control_configuration: nil, commit_mode: nil, display_options: nil, selectable_values: nil, type: nil)
  @filter_control_id = filter_control_id
  Jsii::Type.check_type(@filter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterControlId")
  @source_filter_id = source_filter_id
  Jsii::Type.check_type(@source_filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFilterId")
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title")
  @cascading_control_configuration = cascading_control_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::CascadingControlConfigurationProperty.new(**cascading_control_configuration.transform_keys(&:to_sym)) : cascading_control_configuration
  Jsii::Type.check_type(@cascading_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkNhc2NhZGluZ0NvbnRyb2xDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "cascadingControlConfiguration") unless @cascading_control_configuration.nil?
  @commit_mode = commit_mode
  Jsii::Type.check_type(@commit_mode, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "commitMode") unless @commit_mode.nil?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::DropDownControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkRyb3BEb3duQ29udHJvbERpc3BsYXlPcHRpb25zUHJvcGVydHkifV19fQ==")), "displayOptions") unless @display_options.nil?
  @selectable_values = selectable_values.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::FilterSelectableValuesProperty.new(**selectable_values.transform_keys(&:to_sym)) : selectable_values
  Jsii::Type.check_type(@selectable_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkZpbHRlclNlbGVjdGFibGVWYWx1ZXNQcm9wZXJ0eSJ9XX19")), "selectableValues") unless @selectable_values.nil?
  @type = type
  Jsii::Type.check_type(@type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "type") unless @type.nil?
end

Instance Attribute Details

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

The values that are displayed in a control can be configured to only show values that are valid based on what's selected in other controls.

Returns:

See Also:



9829
9830
9831
 
# File 'quick_sight/cfn_template.rb', line 9829

def cascading_control_configuration
  @cascading_control_configuration
end

#commit_mode ⇒ String? (readonly)

The visibility configuration of the Apply button on a FilterDropDownControl .

Returns:

  • (String, nil)

See Also:



9834
9835
9836
 
# File 'quick_sight/cfn_template.rb', line 9834

def commit_mode
  @commit_mode
end

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

The display options of the FilterDropDownControl .

Returns:

See Also:



9839
9840
9841
 
# File 'quick_sight/cfn_template.rb', line 9839

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterDropDownControl .

Returns:

  • (String)

See Also:



9814
9815
9816
 
# File 'quick_sight/cfn_template.rb', line 9814

def filter_control_id
  @filter_control_id
end

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

A list of selectable values that are used in a control.

Returns:

See Also:



9844
9845
9846
 
# File 'quick_sight/cfn_template.rb', line 9844

def selectable_values
  @selectable_values
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterDropDownControl .

Returns:

  • (String)

See Also:



9819
9820
9821
 
# File 'quick_sight/cfn_template.rb', line 9819

def source_filter_id
  @source_filter_id
end

#title ⇒ String (readonly)

The title of the FilterDropDownControl .

Returns:

  • (String)

See Also:



9824
9825
9826
 
# File 'quick_sight/cfn_template.rb', line 9824

def title
  @title
end

#type ⇒ String? (readonly)

The type of the FilterDropDownControl . Choose one of the following options:.

  • MULTI_SELECT : The user can select multiple entries from a dropdown menu.
  • SINGLE_SELECT : The user can select a single entry from a dropdown menu.

Returns:

  • (String, nil)

See Also:



9852
9853
9854
 
# File 'quick_sight/cfn_template.rb', line 9852

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



9854
9855
9856
9857
9858
9859
9860
9861
9862
9863
9864
9865
 
# File 'quick_sight/cfn_template.rb', line 9854

def self.jsii_properties
  {
    :filter_control_id => "filterControlId",
    :source_filter_id => "sourceFilterId",
    :title => "title",
    :cascading_control_configuration => "cascadingControlConfiguration",
    :commit_mode => "commitMode",
    :display_options => "displayOptions",
    :selectable_values => "selectableValues",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



9867
9868
9869
9870
9871
9872
9873
9874
9875
9876
9877
9878
9879
9880
 
# File 'quick_sight/cfn_template.rb', line 9867

def to_jsii
  result = {}
  result.merge!({
    "filterControlId" => @filter_control_id,
    "sourceFilterId" => @source_filter_id,
    "title" => @title,
    "cascadingControlConfiguration" => @cascading_control_configuration,
    "commitMode" => @commit_mode,
    "displayOptions" => @display_options,
    "selectableValues" => @selectable_values,
    "type" => @type,
  })
  result.compact
end