Class: AWSCDK::QuickSight::CfnTemplate::CustomContentVisualProperty

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



5646
5647
5648
5649
5650
5651
5652
5653
5654
5655
5656
5657
5658
5659
5660
5661
 
# File 'quick_sight/cfn_template.rb', line 5646

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("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5WaXN1YWxDdXN0b21BY3Rpb25Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "actions") unless @actions.nil?
  @chart_configuration = chart_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::CustomContentConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkN1c3RvbUNvbnRlbnRDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "chartConfiguration") unless @chart_configuration.nil?
  @subtitle = subtitle.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualSubtitleLabelOptionsProperty.new(**subtitle.transform_keys(&:to_sym)) : subtitle
  Jsii::Type.check_type(@subtitle, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbFN1YnRpdGxlTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "subtitle") unless @subtitle.nil?
  @title = title.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualTitleLabelOptionsProperty.new(**title.transform_keys(&:to_sym)) : title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbFRpdGxlTGFiZWxPcHRpb25zUHJvcGVydHkifV19fQ==")), "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:



5681
5682
5683
 
# File 'quick_sight/cfn_template.rb', line 5681

def actions
  @actions
end

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

The configuration of a CustomContentVisual .

Returns:

See Also:



5686
5687
5688
 
# File 'quick_sight/cfn_template.rb', line 5686

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:



5669
5670
5671
 
# File 'quick_sight/cfn_template.rb', line 5669

def data_set_identifier
  @data_set_identifier
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



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

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



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

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



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

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:



5676
5677
5678
 
# File 'quick_sight/cfn_template.rb', line 5676

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



5703
5704
5705
5706
5707
5708
5709
5710
5711
5712
5713
 
# File 'quick_sight/cfn_template.rb', line 5703

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 



5715
5716
5717
5718
5719
5720
5721
5722
5723
5724
5725
5726
5727
 
# File 'quick_sight/cfn_template.rb', line 5715

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