Class: AWSCDK::QuickSight::CfnDashboard::CustomContentVisualProperty

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

Overview

A visual that contains custom content.

For more information, see Using custom visual content in the Amazon Quick Suite User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(data_set_identifier:, visual_id:, actions: nil, chart_configuration: nil, subtitle: nil, title: nil, visual_content_alt_text: nil) ⇒ CustomContentVisualProperty

Returns a new instance of CustomContentVisualProperty.

Parameters:



5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
 
# File 'quick_sight/cfn_dashboard.rb', line 5661

def initialize(data_set_identifier:, visual_id:, actions: nil, chart_configuration: nil, subtitle: nil, title: nil, visual_content_alt_text: 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?
  @chart_configuration = chart_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::CustomContentConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5DdXN0b21Db250ZW50Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "chartConfiguration") unless @chart_configuration.nil?
  @subtitle = subtitle.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualSubtitleLabelOptionsProperty.new(**subtitle.transform_keys(&:to_sym)) : subtitle
  Jsii::Type.check_type(@subtitle, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxTdWJ0aXRsZUxhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "subtitle") unless @subtitle.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::VisualTitleLabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5WaXN1YWxUaXRsZUxhYmVsT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "title") unless @title.nil?
  @visual_content_alt_text = visual_content_alt_text
  Jsii::Type.check_type(@visual_content_alt_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualContentAltText") unless @visual_content_alt_text.nil?
end

Instance Attribute Details

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

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

Returns:

See Also:



5696
5697
5698
 
# File 'quick_sight/cfn_dashboard.rb', line 5696

def actions
  @actions
end

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

The configuration of a CustomContentVisual .

Returns:

See Also:



5701
5702
5703
 
# File 'quick_sight/cfn_dashboard.rb', line 5701

def chart_configuration
  @chart_configuration
end

#data_set_identifier ⇒ String (readonly)

The dataset that is used to create the custom content visual.

You can't create a visual without a dataset.

Returns:

  • (String)

See Also:



5684
5685
5686
 
# File 'quick_sight/cfn_dashboard.rb', line 5684

def data_set_identifier
  @data_set_identifier
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



5706
5707
5708
 
# File 'quick_sight/cfn_dashboard.rb', line 5706

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



5711
5712
5713
 
# File 'quick_sight/cfn_dashboard.rb', line 5711

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



5716
5717
5718
 
# File 'quick_sight/cfn_dashboard.rb', line 5716

def visual_content_alt_text
  @visual_content_alt_text
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:



5691
5692
5693
 
# File 'quick_sight/cfn_dashboard.rb', line 5691

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
5728
 
# File 'quick_sight/cfn_dashboard.rb', line 5718

def self.jsii_properties
  {
    :data_set_identifier => "dataSetIdentifier",
    :visual_id => "visualId",
    :actions => "actions",
    :chart_configuration => "chartConfiguration",
    :subtitle => "subtitle",
    :title => "title",
    :visual_content_alt_text => "visualContentAltText",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



5730
5731
5732
5733
5734
5735
5736
5737
5738
5739
5740
5741
5742
 
# File 'quick_sight/cfn_dashboard.rb', line 5730

def to_jsii
  result = {}
  result.merge!({
    "dataSetIdentifier" => @data_set_identifier,
    "visualId" => @visual_id,
    "actions" => @actions,
    "chartConfiguration" => @chart_configuration,
    "subtitle" => @subtitle,
    "title" => @title,
    "visualContentAltText" => @visual_content_alt_text,
  })
  result.compact
end