Class: AWSCDK::QuickSight::CfnDashboard::InsightVisualProperty

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

Overview

An insight visual.

For more information, see Working with insights 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, insight_configuration: nil, subtitle: nil, title: nil, visual_content_alt_text: nil) ⇒ InsightVisualProperty

Returns a new instance of InsightVisualProperty.

Parameters:



16969
16970
16971
16972
16973
16974
16975
16976
16977
16978
16979
16980
16981
16982
16983
16984
 
# File 'quick_sight/cfn_dashboard.rb', line 16969

def initialize(data_set_identifier:, visual_id:, actions: nil, insight_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?
  @insight_configuration = insight_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnDashboard::InsightConfigurationProperty.new(**insight_configuration.transform_keys(&:to_sym)) : insight_configuration
  Jsii::Type.check_type(@insight_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmbkRhc2hib2FyZC5JbnNpZ2h0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "insightConfiguration") unless @insight_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:



17002
17003
17004
 
# File 'quick_sight/cfn_dashboard.rb', line 17002

def actions
  @actions
end

#data_set_identifier ⇒ String (readonly)

The dataset that is used in the insight visual.

Returns:

  • (String)

See Also:



16990
16991
16992
 
# File 'quick_sight/cfn_dashboard.rb', line 16990

def data_set_identifier
  @data_set_identifier
end

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

The configuration of an insight visual.

Returns:

See Also:



17007
17008
17009
 
# File 'quick_sight/cfn_dashboard.rb', line 17007

def insight_configuration
  @insight_configuration
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



17012
17013
17014
 
# File 'quick_sight/cfn_dashboard.rb', line 17012

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



17017
17018
17019
 
# File 'quick_sight/cfn_dashboard.rb', line 17017

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



17022
17023
17024
 
# File 'quick_sight/cfn_dashboard.rb', line 17022

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:



16997
16998
16999
 
# File 'quick_sight/cfn_dashboard.rb', line 16997

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



17024
17025
17026
17027
17028
17029
17030
17031
17032
17033
17034
 
# File 'quick_sight/cfn_dashboard.rb', line 17024

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

Instance Method Details

#to_jsii ⇒ Object 



17036
17037
17038
17039
17040
17041
17042
17043
17044
17045
17046
17047
17048
 
# File 'quick_sight/cfn_dashboard.rb', line 17036

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