Class: AWSCDK::QuickSight::CfnDashboard::ParameterDropDownControlProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_dashboard.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(parameter_control_id:, source_parameter_name:, title:, cascading_control_configuration: nil, commit_mode: nil, display_options: nil, selectable_values: nil, type: nil) ⇒ ParameterDropDownControlProperty

Returns a new instance of ParameterDropDownControlProperty.

Parameters:



21289
21290
21291
21292
21293
21294
21295
21296
21297
21298
21299
21300
21301
21302
21303
21304
21305
21306
 
# File 'quick_sight/cfn_dashboard.rb', line 21289

def initialize(parameter_control_id:, source_parameter_name:, title:, cascading_control_configuration: nil, commit_mode: nil, display_options: nil, selectable_values: nil, type: nil)
  @parameter_control_id = parameter_control_id
  Jsii::Type.check_type(@parameter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "parameterControlId")
  @source_parameter_name = source_parameter_name
  Jsii::Type.check_type(@source_parameter_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceParameterName")
  @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::CfnDashboard::CascadingControlConfigurationProperty.new(**cascading_control_configuration.transform_keys(&:to_sym)) : cascading_control_configuration
  Jsii::Type.check_type(@cascading_control_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DYXNjYWRpbmdDb250cm9sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "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::CfnDashboard::DropDownControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5Ecm9wRG93bkNvbnRyb2xEaXNwbGF5T3B0aW9uc1Byb3BlcnR5In1dfX0=")), "displayOptions") unless @display_options.nil?
  @selectable_values = selectable_values.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::ParameterSelectableValuesProperty.new(**selectable_values.transform_keys(&:to_sym)) : selectable_values
  Jsii::Type.check_type(@selectable_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5QYXJhbWV0ZXJTZWxlY3RhYmxlVmFsdWVzUHJvcGVydHkifV19fQ==")), "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:



21327
21328
21329
 
# File 'quick_sight/cfn_dashboard.rb', line 21327

def cascading_control_configuration
  @cascading_control_configuration
end

#commit_mode ⇒ String? (readonly)

The visibility configuration of the Apply button on a ParameterDropDownControl .

Returns:

  • (String, nil)

See Also:



21332
21333
21334
 
# File 'quick_sight/cfn_dashboard.rb', line 21332

def commit_mode
  @commit_mode
end

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

The display options of a control.

Returns:

See Also:



21337
21338
21339
 
# File 'quick_sight/cfn_dashboard.rb', line 21337

def display_options
  @display_options
end

#parameter_control_id ⇒ String (readonly)

The ID of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



21312
21313
21314
 
# File 'quick_sight/cfn_dashboard.rb', line 21312

def parameter_control_id
  @parameter_control_id
end

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

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

Returns:

See Also:



21342
21343
21344
 
# File 'quick_sight/cfn_dashboard.rb', line 21342

def selectable_values
  @selectable_values
end

#source_parameter_name ⇒ String (readonly)

The source parameter name of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



21317
21318
21319
 
# File 'quick_sight/cfn_dashboard.rb', line 21317

def source_parameter_name
  @source_parameter_name
end

#title ⇒ String (readonly)

The title of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



21322
21323
21324
 
# File 'quick_sight/cfn_dashboard.rb', line 21322

def title
  @title
end

#type ⇒ String? (readonly)

The type parameter name of the ParameterDropDownControl .

Returns:

  • (String, nil)

See Also:



21347
21348
21349
 
# File 'quick_sight/cfn_dashboard.rb', line 21347

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



21349
21350
21351
21352
21353
21354
21355
21356
21357
21358
21359
21360
 
# File 'quick_sight/cfn_dashboard.rb', line 21349

def self.jsii_properties
  {
    :parameter_control_id => "parameterControlId",
    :source_parameter_name => "sourceParameterName",
    :title => "title",
    :cascading_control_configuration => "cascadingControlConfiguration",
    :commit_mode => "commitMode",
    :display_options => "displayOptions",
    :selectable_values => "selectableValues",
    :type => "type",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



21362
21363
21364
21365
21366
21367
21368
21369
21370
21371
21372
21373
21374
21375
 
# File 'quick_sight/cfn_dashboard.rb', line 21362

def to_jsii
  result = {}
  result.merge!({
    "parameterControlId" => @parameter_control_id,
    "sourceParameterName" => @source_parameter_name,
    "title" => @title,
    "cascadingControlConfiguration" => @cascading_control_configuration,
    "commitMode" => @commit_mode,
    "displayOptions" => @display_options,
    "selectableValues" => @selectable_values,
    "type" => @type,
  })
  result.compact
end