Class: AWSCDK::QuickSight::CfnTemplate::FilterTextAreaControlProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::FilterTextAreaControlProperty

Defined in:

quick_sight/cfn_template.rb

Overview

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html

Instance Attribute Summary

• #delimiter ⇒ String^? readonly

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

• #display_options ⇒ AWSCDK::IResolvable, ... readonly

  The display options of a control.

• #filter_control_id ⇒ String readonly

  The ID of the FilterTextAreaControl .

• #source_filter_id ⇒ String readonly

  The source filter ID of the FilterTextAreaControl .

• #title ⇒ String readonly

  The title of the FilterTextAreaControl .

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(filter_control_id:, source_filter_id:, title:, delimiter: nil, display_options: nil) ⇒ FilterTextAreaControlProperty constructor

  A new instance of FilterTextAreaControlProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(filter_control_id:, source_filter_id:, title:, delimiter: nil, display_options: nil) ⇒ FilterTextAreaControlProperty

Returns a new instance of FilterTextAreaControlProperty.

Parameters:

• filter_control_id (String) —

  The ID of the FilterTextAreaControl .

• source_filter_id (String) —

  The source filter ID of the FilterTextAreaControl .

• title (String) —

  The title of the FilterTextAreaControl .

• 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.

# File 'quick_sight/cfn_template.rb', line 10606

def initialize(filter_control_id:, source_filter_id:, title:, delimiter: nil, display_options: nil)
  @filter_control_id = filter_control_id
  Jsii::Type.check_type(@filter_control_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "filterControlId")
  @source_filter_id = source_filter_id
  Jsii::Type.check_type(@source_filter_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sourceFilterId")
  @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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-delimiter

# File 'quick_sight/cfn_template.rb', line 10638

def delimiter
  @delimiter
end

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

The display options of a control.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::TextAreaControlDisplayOptionsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-displayoptions

# File 'quick_sight/cfn_template.rb', line 10643

def display_options
  @display_options
end

#filter_control_id ⇒ String (readonly)

The ID of the FilterTextAreaControl .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-filtercontrolid

# File 'quick_sight/cfn_template.rb', line 10623

def filter_control_id
  @filter_control_id
end

#source_filter_id ⇒ String (readonly)

The source filter ID of the FilterTextAreaControl .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-sourcefilterid

# File 'quick_sight/cfn_template.rb', line 10628

def source_filter_id
  @source_filter_id
end

#title ⇒ String (readonly)

The title of the FilterTextAreaControl .

Returns:

• (String)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-filtertextareacontrol.html#cfn-quicksight-template-filtertextareacontrol-title

# File 'quick_sight/cfn_template.rb', line 10633

def title
  @title
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 10645

def self.jsii_properties
  {
    :filter_control_id => "filterControlId",
    :source_filter_id => "sourceFilterId",
    :title => "title",
    :delimiter => "delimiter",
    :display_options => "displayOptions",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 10655

def to_jsii
  result = {}
  result.merge!({
    "filterControlId" => @filter_control_id,
    "sourceFilterId" => @source_filter_id,
    "title" => @title,
    "delimiter" => @delimiter,
    "displayOptions" => @display_options,
  })
  result.compact
end