Class: AWSCDK::QuickSight::CfnDashboard::SheetTextBoxProperty

Inherits:

Jsii::Struct

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

Defined in:

quick_sight/cfn_dashboard.rb

Overview

A text box.

See Also:

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

Instance Attribute Summary

• #content ⇒ String^? readonly

  The content that is displayed in the text box.

• #sheet_text_box_id ⇒ String readonly

  The unique identifier for a text box.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(sheet_text_box_id:, content: nil) ⇒ SheetTextBoxProperty constructor

  A new instance of SheetTextBoxProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(sheet_text_box_id:, content: nil) ⇒ SheetTextBoxProperty

Returns a new instance of SheetTextBoxProperty.

Parameters:

• sheet_text_box_id (String) —

  The unique identifier for a text box.

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

  The content that is displayed in the text box.

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

def initialize(sheet_text_box_id:, content: nil)
  @sheet_text_box_id = sheet_text_box_id
  Jsii::Type.check_type(@sheet_text_box_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetTextBoxId")
  @content = content
  Jsii::Type.check_type(@content, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "content") unless @content.nil?
end

Instance Attribute Details

#content ⇒ String^? (readonly)

The content that is displayed in the text box.

Returns:

• (String, nil)

See Also:

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

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

def content
  @content
end

#sheet_text_box_id ⇒ String (readonly)

The unique identifier for a text box.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

Returns:

• (String)

See Also:

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

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

def sheet_text_box_id
  @sheet_text_box_id
end

Class Method Details

.jsii_properties ⇒ Object

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

def self.jsii_properties
  {
    :sheet_text_box_id => "sheetTextBoxId",
    :content => "content",
  }
end

Instance Method Details

#to_jsii ⇒ Object

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

def to_jsii
  result = {}
  result.merge!({
    "sheetTextBoxId" => @sheet_text_box_id,
    "content" => @content,
  })
  result.compact
end