Class: AWSCDK::QuickSight::CfnDashboard::ShortFormatTextProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnDashboard::ShortFormatTextProperty

Defined in:

quick_sight/cfn_dashboard.rb

Overview

The text format for the title.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

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

Instance Attribute Summary

• #plain_text ⇒ String^? readonly

  Plain text format.

• #rich_text ⇒ String^? readonly

  Rich text.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(plain_text: nil, rich_text: nil) ⇒ ShortFormatTextProperty constructor

  A new instance of ShortFormatTextProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(plain_text: nil, rich_text: nil) ⇒ ShortFormatTextProperty

Returns a new instance of ShortFormatTextProperty.

Parameters:

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

  Plain text format.

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

  Rich text.

# File 'quick_sight/cfn_dashboard.rb', line 27770

def initialize(plain_text: nil, rich_text: nil)
  @plain_text = plain_text
  Jsii::Type.check_type(@plain_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "plainText") unless @plain_text.nil?
  @rich_text = rich_text
  Jsii::Type.check_type(@rich_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "richText") unless @rich_text.nil?
end

Instance Attribute Details

#plain_text ⇒ String^? (readonly)

Plain text format.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shortformattext.html#cfn-quicksight-dashboard-shortformattext-plaintext

# File 'quick_sight/cfn_dashboard.rb', line 27781

def plain_text
  @plain_text
end

#rich_text ⇒ String^? (readonly)

Rich text.

Examples of rich text include bold, underline, and italics.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-dashboard-shortformattext.html#cfn-quicksight-dashboard-shortformattext-richtext

# File 'quick_sight/cfn_dashboard.rb', line 27788

def rich_text
  @rich_text
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 27790

def self.jsii_properties
  {
    :plain_text => "plainText",
    :rich_text => "richText",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_dashboard.rb', line 27797

def to_jsii
  result = {}
  result.merge!({
    "plainText" => @plain_text,
    "richText" => @rich_text,
  })
  result.compact
end