Class: AWSCDK::QuickSight::CfnTemplate::ParameterDropDownControlProperty

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(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:



18506
18507
18508
18509
18510
18511
18512
18513
18514
18515
18516
18517
18518
18519
18520
18521
18522
18523
 
# File 'quick_sight/cfn_template.rb', line 18506

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::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::ParameterSelectableValuesProperty.new(**selectable_values.transform_keys(&:to_sym)) : selectable_values
  Jsii::Type.check_type(@selectable_values, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBhcmFtZXRlclNlbGVjdGFibGVWYWx1ZXNQcm9wZXJ0eSJ9XX19")), "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:



18544
18545
18546
 
# File 'quick_sight/cfn_template.rb', line 18544

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:



18549
18550
18551
 
# File 'quick_sight/cfn_template.rb', line 18549

def commit_mode
  @commit_mode
end

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

The display options of a control.

Returns:

See Also:



18554
18555
18556
 
# File 'quick_sight/cfn_template.rb', line 18554

def display_options
  @display_options
end

#parameter_control_id ⇒ String (readonly)

The ID of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



18529
18530
18531
 
# File 'quick_sight/cfn_template.rb', line 18529

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:



18559
18560
18561
 
# File 'quick_sight/cfn_template.rb', line 18559

def selectable_values
  @selectable_values
end

#source_parameter_name ⇒ String (readonly)

The source parameter name of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



18534
18535
18536
 
# File 'quick_sight/cfn_template.rb', line 18534

def source_parameter_name
  @source_parameter_name
end

#title ⇒ String (readonly)

The title of the ParameterDropDownControl .

Returns:

  • (String)

See Also:



18539
18540
18541
 
# File 'quick_sight/cfn_template.rb', line 18539

def title
  @title
end

#type ⇒ String? (readonly)

The type parameter name of the ParameterDropDownControl .

Returns:

  • (String, nil)

See Also:



18564
18565
18566
 
# File 'quick_sight/cfn_template.rb', line 18564

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



18566
18567
18568
18569
18570
18571
18572
18573
18574
18575
18576
18577
 
# File 'quick_sight/cfn_template.rb', line 18566

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 



18579
18580
18581
18582
18583
18584
18585
18586
18587
18588
18589
18590
18591
18592
 
# File 'quick_sight/cfn_template.rb', line 18579

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