Class: AWSCDK::QuickSight::CfnDashboard::ParameterControlProperty

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

Overview

The control of a parameter that users can interact with in 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(date_time_picker: nil, dropdown: nil, list: nil, slider: nil, text_area: nil, text_field: nil) ⇒ ParameterControlProperty

Returns a new instance of ParameterControlProperty.

Parameters:



21072
21073
21074
21075
21076
21077
21078
21079
21080
21081
21082
21083
21084
21085
 
# File 'quick_sight/cfn_dashboard.rb', line 21072

def initialize(date_time_picker: nil, dropdown: nil, list: nil, slider: nil, text_area: nil, text_field: nil)
  @date_time_picker = date_time_picker.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterDateTimePickerControlProperty.new(**date_time_picker.transform_keys(&:to_sym)) : date_time_picker
  Jsii::Type.check_type(@date_time_picker, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJEYXRlVGltZVBpY2tlckNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "dateTimePicker") unless @date_time_picker.nil?
  @dropdown = dropdown.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterDropDownControlProperty.new(**dropdown.transform_keys(&:to_sym)) : dropdown
  Jsii::Type.check_type(@dropdown, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJEcm9wRG93bkNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "dropdown") unless @dropdown.nil?
  @list = list.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterListControlProperty.new(**list.transform_keys(&:to_sym)) : list
  Jsii::Type.check_type(@list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJMaXN0Q29udHJvbFByb3BlcnR5In1dfX0=")), "list") unless @list.nil?
  @slider = slider.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterSliderControlProperty.new(**slider.transform_keys(&:to_sym)) : slider
  Jsii::Type.check_type(@slider, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJTbGlkZXJDb250cm9sUHJvcGVydHkifV19fQ==")), "slider") unless @slider.nil?
  @text_area = text_area.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterTextAreaControlProperty.new(**text_area.transform_keys(&:to_sym)) : text_area
  Jsii::Type.check_type(@text_area, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJUZXh0QXJlYUNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "textArea") unless @text_area.nil?
  @text_field = text_field.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterTextFieldControlProperty.new(**text_field.transform_keys(&:to_sym)) : text_field
  Jsii::Type.check_type(@text_field, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJUZXh0RmllbGRDb250cm9sUHJvcGVydHkifV19fQ==")), "textField") unless @text_field.nil?
end

Instance Attribute Details

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

A control from a date parameter that specifies date and time.

Returns:

See Also:



21091
21092
21093
 
# File 'quick_sight/cfn_dashboard.rb', line 21091

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:



21096
21097
21098
 
# File 'quick_sight/cfn_dashboard.rb', line 21096

def dropdown
  @dropdown
end

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

A control to display a list with buttons or boxes that are used to select either a single value or multiple values.

Returns:

See Also:



21101
21102
21103
 
# File 'quick_sight/cfn_dashboard.rb', line 21101

def list
  @list
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:



21108
21109
21110
 
# File 'quick_sight/cfn_dashboard.rb', line 21108

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:



21113
21114
21115
 
# File 'quick_sight/cfn_dashboard.rb', line 21113

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:



21118
21119
21120
 
# File 'quick_sight/cfn_dashboard.rb', line 21118

def text_field
  @text_field
end

Class Method Details

.jsii_properties ⇒ Object 



21120
21121
21122
21123
21124
21125
21126
21127
21128
21129
 
# File 'quick_sight/cfn_dashboard.rb', line 21120

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

Instance Method Details

#to_jsii ⇒ Object 



21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
21141
21142
 
# File 'quick_sight/cfn_dashboard.rb', line 21131

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