Class: AWSCDK::QuickSight::CfnDashboard::EmptyVisualProperty

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

Overview

An empty visual.

Empty visuals are used in layouts but have not been configured to show any data. A new visual created in the Quick Sight console is considered an EmptyVisual until a visual type is selected.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_set_identifier:, visual_id:, actions: nil) ⇒ EmptyVisualProperty

Returns a new instance of EmptyVisualProperty.

Parameters:



9418
9419
9420
9421
9422
9423
9424
9425
 
# File 'quick_sight/cfn_dashboard.rb', line 9418

def initialize(data_set_identifier:, visual_id:, actions: nil)
  @data_set_identifier = data_set_identifier
  Jsii::Type.check_type(@data_set_identifier, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "dataSetIdentifier")
  @visual_id = visual_id
  Jsii::Type.check_type(@visual_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualId")
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5EYXNoYm9hcmQuVmlzdWFsQ3VzdG9tQWN0aW9uUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "actions") unless @actions.nil?
end

Instance Attribute Details

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

The list of custom actions that are configured for a visual.

Returns:

See Also:



9445
9446
9447
 
# File 'quick_sight/cfn_dashboard.rb', line 9445

def actions
  @actions
end

#data_set_identifier ⇒ String (readonly)

The data set that is used in the empty visual.

Every visual requires a dataset to render.

Returns:

  • (String)

See Also:



9433
9434
9435
 
# File 'quick_sight/cfn_dashboard.rb', line 9433

def data_set_identifier
  @data_set_identifier
end

#visual_id ⇒ String (readonly)

The unique identifier of a visual.

This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

Returns:

  • (String)

See Also:



9440
9441
9442
 
# File 'quick_sight/cfn_dashboard.rb', line 9440

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



9447
9448
9449
9450
9451
9452
9453
 
# File 'quick_sight/cfn_dashboard.rb', line 9447

def self.jsii_properties
  {
    :data_set_identifier => "dataSetIdentifier",
    :visual_id => "visualId",
    :actions => "actions",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



9455
9456
9457
9458
9459
9460
9461
9462
9463
 
# File 'quick_sight/cfn_dashboard.rb', line 9455

def to_jsii
  result = {}
  result.merge!({
    "dataSetIdentifier" => @data_set_identifier,
    "visualId" => @visual_id,
    "actions" => @actions,
  })
  result.compact
end