Class: AWSCDK::QuickSight::CfnTemplate::EmptyVisualProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
quick_sight/cfn_template.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:



8605
8606
8607
8608
8609
8610
8611
8612
 
# File 'quick_sight/cfn_template.rb', line 8605

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5WaXN1YWxDdXN0b21BY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "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:



8632
8633
8634
 
# File 'quick_sight/cfn_template.rb', line 8632

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:



8620
8621
8622
 
# File 'quick_sight/cfn_template.rb', line 8620

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:



8627
8628
8629
 
# File 'quick_sight/cfn_template.rb', line 8627

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



8634
8635
8636
8637
8638
8639
8640
 
# File 'quick_sight/cfn_template.rb', line 8634

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

Instance Method Details

#to_jsii ⇒ Object 



8642
8643
8644
8645
8646
8647
8648
8649
8650
 
# File 'quick_sight/cfn_template.rb', line 8642

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