Class: AWSCDK::QuickSight::CfnAnalysis::SheetProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnAnalysis::SheetProperty

Defined in:

quick_sight/cfn_analysis.rb

Overview

A sheet , which is an object that contains a set of visuals that are viewed together on one page in Quick Sight.

Every analysis and dashboard contains at least one sheet. Each sheet contains at least one visualization widget, for example a chart, pivot table, or narrative insight. Sheets can be associated with other components, such as controls, filters, and so on.

See Also:

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

Instance Attribute Summary

• #name ⇒ String^? readonly

  The name of a sheet.

• #sheet_id ⇒ String^? readonly

  The unique identifier associated with a sheet.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(name: nil, sheet_id: nil) ⇒ SheetProperty constructor

  A new instance of SheetProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(name: nil, sheet_id: nil) ⇒ SheetProperty

Returns a new instance of SheetProperty.

Parameters:

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

  The name of a sheet.

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

  The unique identifier associated with a sheet.

# File 'quick_sight/cfn_analysis.rb', line 26584

def initialize(name: nil, sheet_id: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @sheet_id = sheet_id
  Jsii::Type.check_type(@sheet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetId") unless @sheet_id.nil?
end

Instance Attribute Details

#name ⇒ String^? (readonly)

The name of a sheet.

This name is displayed on the sheet's tab in the Quick Sight console.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-name

# File 'quick_sight/cfn_analysis.rb', line 26597

def name
  @name
end

#sheet_id ⇒ String^? (readonly)

The unique identifier associated with a sheet.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-analysis-sheet.html#cfn-quicksight-analysis-sheet-sheetid

# File 'quick_sight/cfn_analysis.rb', line 26602

def sheet_id
  @sheet_id
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 26604

def self.jsii_properties
  {
    :name => "name",
    :sheet_id => "sheetId",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_analysis.rb', line 26611

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "sheetId" => @sheet_id,
  })
  result.compact
end