Class: AWSCDK::QuickSight::CfnTemplate::SheetDefinitionProperty

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

Overview

A sheet is an object that contains a set of visuals that are viewed together on one page in a paginated report.

Every analysis and dashboard must contain at least one sheet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sheet_id:, content_type: nil, description: nil, filter_controls: nil, images: nil, layouts: nil, name: nil, parameter_controls: nil, sheet_control_layouts: nil, text_boxes: nil, title: nil, visuals: nil) ⇒ SheetDefinitionProperty

Returns a new instance of SheetDefinitionProperty.

Parameters:



24208
24209
24210
24211
24212
24213
24214
24215
24216
24217
24218
24219
24220
24221
24222
24223
24224
24225
24226
24227
24228
24229
24230
24231
24232
24233
 
# File 'quick_sight/cfn_template.rb', line 24208

def initialize(sheet_id:, content_type: nil, description: nil, filter_controls: nil, images: nil, layouts: nil, name: nil, parameter_controls: nil, sheet_control_layouts: nil, text_boxes: nil, title: nil, visuals: nil)
  @sheet_id = sheet_id
  Jsii::Type.check_type(@sheet_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetId")
  @content_type = content_type
  Jsii::Type.check_type(@content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless @content_type.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @filter_controls = filter_controls
  Jsii::Type.check_type(@filter_controls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5GaWx0ZXJDb250cm9sUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "filterControls") unless @filter_controls.nil?
  @images = images
  Jsii::Type.check_type(@images, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5TaGVldEltYWdlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "images") unless @images.nil?
  @layouts = layouts
  Jsii::Type.check_type(@layouts, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5MYXlvdXRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "layouts") unless @layouts.nil?
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless @name.nil?
  @parameter_controls = parameter_controls
  Jsii::Type.check_type(@parameter_controls, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5QYXJhbWV0ZXJDb250cm9sUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "parameterControls") unless @parameter_controls.nil?
  @sheet_control_layouts = sheet_control_layouts
  Jsii::Type.check_type(@sheet_control_layouts, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5TaGVldENvbnRyb2xMYXlvdXRQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "sheetControlLayouts") unless @sheet_control_layouts.nil?
  @text_boxes = text_boxes
  Jsii::Type.check_type(@text_boxes, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5TaGVldFRleHRCb3hQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "textBoxes") unless @text_boxes.nil?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
  @visuals = visuals
  Jsii::Type.check_type(@visuals, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5WaXN1YWxQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "visuals") unless @visuals.nil?
end

Instance Attribute Details

#content_type ⇒ String? (readonly)

The layout content type of the sheet. Choose one of the following options:.

  • PAGINATED : Creates a sheet for a paginated report.
  • INTERACTIVE : Creates a sheet for an interactive dashboard.

Returns:

  • (String, nil)

See Also:



24247
24248
24249
 
# File 'quick_sight/cfn_template.rb', line 24247

def content_type
  @content_type
end

#description ⇒ String? (readonly)

A description of the sheet.

Returns:

  • (String, nil)

See Also:



24252
24253
24254
 
# File 'quick_sight/cfn_template.rb', line 24252

def description
  @description
end

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

The list of filter controls that are on a sheet.

For more information, see Adding filter controls to analysis sheets in the Amazon Quick Suite User Guide .

Returns:

See Also:



24259
24260
24261
 
# File 'quick_sight/cfn_template.rb', line 24259

def filter_controls
  @filter_controls
end

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

A list of images on a sheet.

Returns:

See Also:



24264
24265
24266
 
# File 'quick_sight/cfn_template.rb', line 24264

def images
  @images
end

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

Layouts define how the components of a sheet are arranged.

For more information, see Types of layout in the Amazon Quick Suite User Guide .

Returns:

See Also:



24271
24272
24273
 
# File 'quick_sight/cfn_template.rb', line 24271

def layouts
  @layouts
end

#name ⇒ String? (readonly)

The name of the sheet.

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

Returns:

  • (String, nil)

See Also:



24278
24279
24280
 
# File 'quick_sight/cfn_template.rb', line 24278

def name
  @name
end

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

The list of parameter controls that are on a sheet.

For more information, see Using a Control with a Parameter in Amazon Quick Sight in the Amazon Quick Suite User Guide .

Returns:

See Also:



24285
24286
24287
 
# File 'quick_sight/cfn_template.rb', line 24285

def parameter_controls
  @parameter_controls
end

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

The control layouts of the sheet.

Returns:

See Also:



24290
24291
24292
 
# File 'quick_sight/cfn_template.rb', line 24290

def sheet_control_layouts
  @sheet_control_layouts
end

#sheet_id ⇒ String (readonly)

The unique identifier of a sheet.

Returns:

  • (String)

See Also:



24239
24240
24241
 
# File 'quick_sight/cfn_template.rb', line 24239

def sheet_id
  @sheet_id
end

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

The text boxes that are on a sheet.

Returns:

See Also:



24295
24296
24297
 
# File 'quick_sight/cfn_template.rb', line 24295

def text_boxes
  @text_boxes
end

#title ⇒ String? (readonly)

The title of the sheet.

Returns:

  • (String, nil)

See Also:



24300
24301
24302
 
# File 'quick_sight/cfn_template.rb', line 24300

def title
  @title
end

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

A list of the visuals that are on a sheet.

Visual placement is determined by the layout of the sheet.

Returns:

See Also:



24307
24308
24309
 
# File 'quick_sight/cfn_template.rb', line 24307

def visuals
  @visuals
end

Class Method Details

.jsii_properties ⇒ Object 



24309
24310
24311
24312
24313
24314
24315
24316
24317
24318
24319
24320
24321
24322
24323
24324
 
# File 'quick_sight/cfn_template.rb', line 24309

def self.jsii_properties
  {
    :sheet_id => "sheetId",
    :content_type => "contentType",
    :description => "description",
    :filter_controls => "filterControls",
    :images => "images",
    :layouts => "layouts",
    :name => "name",
    :parameter_controls => "parameterControls",
    :sheet_control_layouts => "sheetControlLayouts",
    :text_boxes => "textBoxes",
    :title => "title",
    :visuals => "visuals",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



24326
24327
24328
24329
24330
24331
24332
24333
24334
24335
24336
24337
24338
24339
24340
24341
24342
24343
 
# File 'quick_sight/cfn_template.rb', line 24326

def to_jsii
  result = {}
  result.merge!({
    "sheetId" => @sheet_id,
    "contentType" => @content_type,
    "description" => @description,
    "filterControls" => @filter_controls,
    "images" => @images,
    "layouts" => @layouts,
    "name" => @name,
    "parameterControls" => @parameter_controls,
    "sheetControlLayouts" => @sheet_control_layouts,
    "textBoxes" => @text_boxes,
    "title" => @title,
    "visuals" => @visuals,
  })
  result.compact
end