Class: AWSCDK::QuickSight::CfnTemplate::ParameterControlProperty

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



18289
18290
18291
18292
18293
18294
18295
18296
18297
18298
18299
18300
18301
18302
 
# File 'quick_sight/cfn_template.rb', line 18289

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::CfnTemplate::ParameterDateTimePickerControlProperty.new(**date_time_picker.transform_keys(&:to_sym)) : date_time_picker
  Jsii::Type.check_type(@date_time_picker, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlckRhdGVUaW1lUGlja2VyQ29udHJvbFByb3BlcnR5In1dfX0=")), "dateTimePicker") unless @date_time_picker.nil?
  @dropdown = dropdown.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ParameterDropDownControlProperty.new(**dropdown.transform_keys(&:to_sym)) : dropdown
  Jsii::Type.check_type(@dropdown, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlckRyb3BEb3duQ29udHJvbFByb3BlcnR5In1dfX0=")), "dropdown") unless @dropdown.nil?
  @list = list.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ParameterListControlProperty.new(**list.transform_keys(&:to_sym)) : list
  Jsii::Type.check_type(@list, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlckxpc3RDb250cm9sUHJvcGVydHkifV19fQ==")), "list") unless @list.nil?
  @slider = slider.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ParameterSliderControlProperty.new(**slider.transform_keys(&:to_sym)) : slider
  Jsii::Type.check_type(@slider, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlclNsaWRlckNvbnRyb2xQcm9wZXJ0eSJ9XX19")), "slider") unless @slider.nil?
  @text_area = text_area.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ParameterTextAreaControlProperty.new(**text_area.transform_keys(&:to_sym)) : text_area
  Jsii::Type.check_type(@text_area, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlclRleHRBcmVhQ29udHJvbFByb3BlcnR5In1dfX0=")), "textArea") unless @text_area.nil?
  @text_field = text_field.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ParameterTextFieldControlProperty.new(**text_field.transform_keys(&:to_sym)) : text_field
  Jsii::Type.check_type(@text_field, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlclRleHRGaWVsZENvbnRyb2xQcm9wZXJ0eSJ9XX19")), "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:



18308
18309
18310
 
# File 'quick_sight/cfn_template.rb', line 18308

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:



18313
18314
18315
 
# File 'quick_sight/cfn_template.rb', line 18313

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:



18318
18319
18320
 
# File 'quick_sight/cfn_template.rb', line 18318

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:



18325
18326
18327
 
# File 'quick_sight/cfn_template.rb', line 18325

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:



18330
18331
18332
 
# File 'quick_sight/cfn_template.rb', line 18330

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:



18335
18336
18337
 
# File 'quick_sight/cfn_template.rb', line 18335

def text_field
  @text_field
end

Class Method Details

.jsii_properties ⇒ Object 



18337
18338
18339
18340
18341
18342
18343
18344
18345
18346
 
# File 'quick_sight/cfn_template.rb', line 18337

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 



18348
18349
18350
18351
18352
18353
18354
18355
18356
18357
18358
18359
 
# File 'quick_sight/cfn_template.rb', line 18348

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