Class: AWSCDK::QuickSight::CfnTemplate::ParameterTextAreaControlProperty

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

Overview

A control to display a text box that is used to enter multiple entries.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(parameter_control_id:, source_parameter_name:, title:, delimiter: nil, display_options: nil) ⇒ ParameterTextAreaControlProperty

Returns a new instance of ParameterTextAreaControlProperty.

Parameters:

  • parameter_control_id (String) —

    The ID of the ParameterTextAreaControl .

  • source_parameter_name (String) —

    The source parameter name of the ParameterTextAreaControl .

  • title (String) —

    The title of the ParameterTextAreaControl .

  • delimiter (String, nil) (defaults to: nil) —

    The delimiter that is used to separate the lines in text.

  • display_options (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TextAreaControlDisplayOptionsProperty, nil) (defaults to: nil) —

    The display options of a control.



18840
18841
18842
18843
18844
18845
18846
18847
18848
18849
18850
18851
 
# File 'quick_sight/cfn_template.rb', line 18840

def initialize(parameter_control_id:, source_parameter_name:, title:, delimiter: nil, display_options: 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")
  @delimiter = delimiter
  Jsii::Type.check_type(@delimiter, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "delimiter") unless @delimiter.nil?
  @display_options = display_options.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::TextAreaControlDisplayOptionsProperty.new(**display_options.transform_keys(&:to_sym)) : display_options
  Jsii::Type.check_type(@display_options, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlRleHRBcmVhQ29udHJvbERpc3BsYXlPcHRpb25zUHJvcGVydHkifV19fQ==")), "displayOptions") unless @display_options.nil?
end

Instance Attribute Details

#delimiter ⇒ String? (readonly)

The delimiter that is used to separate the lines in text.

Returns:

  • (String, nil)

See Also:



18872
18873
18874
 
# File 'quick_sight/cfn_template.rb', line 18872

def delimiter
  @delimiter
end

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

The display options of a control.

Returns:

See Also:



18877
18878
18879
 
# File 'quick_sight/cfn_template.rb', line 18877

def display_options
  @display_options
end

#parameter_control_id ⇒ String (readonly)

The ID of the ParameterTextAreaControl .

Returns:

  • (String)

See Also:



18857
18858
18859
 
# File 'quick_sight/cfn_template.rb', line 18857

def parameter_control_id
  @parameter_control_id
end

#source_parameter_name ⇒ String (readonly)

The source parameter name of the ParameterTextAreaControl .

Returns:

  • (String)

See Also:



18862
18863
18864
 
# File 'quick_sight/cfn_template.rb', line 18862

def source_parameter_name
  @source_parameter_name
end

#title ⇒ String (readonly)

The title of the ParameterTextAreaControl .

Returns:

  • (String)

See Also:



18867
18868
18869
 
# File 'quick_sight/cfn_template.rb', line 18867

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object 



18879
18880
18881
18882
18883
18884
18885
18886
18887
 
# File 'quick_sight/cfn_template.rb', line 18879

def self.jsii_properties
  {
    :parameter_control_id => "parameterControlId",
    :source_parameter_name => "sourceParameterName",
    :title => "title",
    :delimiter => "delimiter",
    :display_options => "displayOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



18889
18890
18891
18892
18893
18894
18895
18896
18897
18898
18899
 
# File 'quick_sight/cfn_template.rb', line 18889

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