Class: AWSCDK::QuickSight::CfnTemplate::PluginVisualProperty

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

Overview

A flexible visualization type that allows engineers to create new custom charts in Quick Sight.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(plugin_arn:, visual_id:, chart_configuration: nil, subtitle: nil, title: nil, visual_content_alt_text: nil) ⇒ PluginVisualProperty

Returns a new instance of PluginVisualProperty.

Parameters:



21127
21128
21129
21130
21131
21132
21133
21134
21135
21136
21137
21138
21139
21140
 
# File 'quick_sight/cfn_template.rb', line 21127

def initialize(plugin_arn:, visual_id:, chart_configuration: nil, subtitle: nil, title: nil, visual_content_alt_text: nil)
  @plugin_arn = plugin_arn
  Jsii::Type.check_type(@plugin_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "pluginArn")
  @visual_id = visual_id
  Jsii::Type.check_type(@visual_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "visualId")
  @chart_configuration = chart_configuration.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::PluginVisualConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlBsdWdpblZpc3VhbENvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "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

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

A description of the plugin field wells and their persisted properties.

Returns:

See Also:



21156
21157
21158
 
# File 'quick_sight/cfn_template.rb', line 21156

def chart_configuration
  @chart_configuration
end

#plugin_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) that reflects the plugin and version.

Returns:

  • (String)

See Also:



21146
21147
21148
 
# File 'quick_sight/cfn_template.rb', line 21146

def plugin_arn
  @plugin_arn
end

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

Returns:

See Also:



21159
21160
21161
 
# File 'quick_sight/cfn_template.rb', line 21159

def subtitle
  @subtitle
end

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

Returns:

See Also:



21162
21163
21164
 
# File 'quick_sight/cfn_template.rb', line 21162

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



21167
21168
21169
 
# File 'quick_sight/cfn_template.rb', line 21167

def visual_content_alt_text
  @visual_content_alt_text
end

#visual_id ⇒ String (readonly)

The ID of the visual that you want to use.

Returns:

  • (String)

See Also:



21151
21152
21153
 
# File 'quick_sight/cfn_template.rb', line 21151

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



21169
21170
21171
21172
21173
21174
21175
21176
21177
21178
 
# File 'quick_sight/cfn_template.rb', line 21169

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

Instance Method Details

#to_jsii ⇒ Object 



21180
21181
21182
21183
21184
21185
21186
21187
21188
21189
21190
21191
 
# File 'quick_sight/cfn_template.rb', line 21180

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