Class: AWSCDK::QuickSight::CfnTemplate::ParameterListControlProperty

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

Overview

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

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, display_options: nil, selectable_values: nil, type: nil) ⇒ ParameterListControlProperty

Returns a new instance of ParameterListControlProperty.

Parameters:



18608
18609
18610
18611
18612
18613
18614
18615
18616
18617
18618
18619
18620
18621
18622
18623
 
# File 'quick_sight/cfn_template.rb', line 18608

def initialize(parameter_control_id:, source_parameter_name:, title:, cascading_control_configuration: 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?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ListControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkxpc3RDb250cm9sRGlzcGxheU9wdGlvbnNQcm9wZXJ0eSJ9XX19")), "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:



18644
18645
18646
 
# File 'quick_sight/cfn_template.rb', line 18644

def cascading_control_configuration
  @cascading_control_configuration
end

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

The display options of a control.

Returns:

See Also:



18649
18650
18651
 
# File 'quick_sight/cfn_template.rb', line 18649

def display_options
  @display_options
end

#parameter_control_id ⇒ String (readonly)

The ID of the ParameterListControl .

Returns:

  • (String)

See Also:



18629
18630
18631
 
# File 'quick_sight/cfn_template.rb', line 18629

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:



18654
18655
18656
 
# File 'quick_sight/cfn_template.rb', line 18654

def selectable_values
  @selectable_values
end

#source_parameter_name ⇒ String (readonly)

The source parameter name of the ParameterListControl .

Returns:

  • (String)

See Also:



18634
18635
18636
 
# File 'quick_sight/cfn_template.rb', line 18634

def source_parameter_name
  @source_parameter_name
end

#title ⇒ String (readonly)

The title of the ParameterListControl .

Returns:

  • (String)

See Also:



18639
18640
18641
 
# File 'quick_sight/cfn_template.rb', line 18639

def title
  @title
end

#type ⇒ String? (readonly)

The type of ParameterListControl .

Returns:

  • (String, nil)

See Also:



18659
18660
18661
 
# File 'quick_sight/cfn_template.rb', line 18659

def type
  @type
end

Class Method Details

.jsii_properties ⇒ Object 



18661
18662
18663
18664
18665
18666
18667
18668
18669
18670
18671
 
# File 'quick_sight/cfn_template.rb', line 18661

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

Instance Method Details

#to_jsii ⇒ Object 



18673
18674
18675
18676
18677
18678
18679
18680
18681
18682
18683
18684
18685
 
# File 'quick_sight/cfn_template.rb', line 18673

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