Class: AWSCDK::QuickSight::CfnTemplate::KPIVisualProperty

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

Overview

A key performance indicator (KPI).

For more information, see Using KPIs in the Amazon Quick Suite User Guide .

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(visual_id:, actions: nil, chart_configuration: nil, column_hierarchies: nil, conditional_formatting: nil, subtitle: nil, title: nil, visual_content_alt_text: nil) ⇒ KPIVisualProperty

Returns a new instance of KPIVisualProperty.

Parameters:



15408
15409
15410
15411
15412
15413
15414
15415
15416
15417
15418
15419
15420
15421
15422
15423
15424
15425
 
# File 'quick_sight/cfn_template.rb', line 15408

def initialize(visual_id:, actions: nil, chart_configuration: nil, column_hierarchies: nil, conditional_formatting: nil, subtitle: nil, title: nil, visual_content_alt_text: nil)
  @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::KPIConfigurationProperty.new(**chart_configuration.transform_keys(&:to_sym)) : chart_configuration
  Jsii::Type.check_type(@chart_configuration, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLktQSUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "chartConfiguration") unless @chart_configuration.nil?
  @column_hierarchies = column_hierarchies
  Jsii::Type.check_type(@column_hierarchies, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5Db2x1bW5IaWVyYXJjaHlQcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "columnHierarchies") unless @column_hierarchies.nil?
  @conditional_formatting = conditional_formatting.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::KPIConditionalFormattingProperty.new(**conditional_formatting.transform_keys(&:to_sym)) : conditional_formatting
  Jsii::Type.check_type(@conditional_formatting, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLktQSUNvbmRpdGlvbmFsRm9ybWF0dGluZ1Byb3BlcnR5In1dfX0=")), "conditionalFormatting") unless @conditional_formatting.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:



15438
15439
15440
 
# File 'quick_sight/cfn_template.rb', line 15438

def actions
  @actions
end

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

The configuration of a KPI visual.

Returns:

See Also:



15443
15444
15445
 
# File 'quick_sight/cfn_template.rb', line 15443

def chart_configuration
  @chart_configuration
end

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

The column hierarchy that is used during drill-downs and drill-ups.

Returns:

See Also:



15448
15449
15450
 
# File 'quick_sight/cfn_template.rb', line 15448

def column_hierarchies
  @column_hierarchies
end

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

The conditional formatting of a KPI visual.

Returns:

See Also:



15453
15454
15455
 
# File 'quick_sight/cfn_template.rb', line 15453

def conditional_formatting
  @conditional_formatting
end

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

The subtitle that is displayed on the visual.

Returns:

See Also:



15458
15459
15460
 
# File 'quick_sight/cfn_template.rb', line 15458

def subtitle
  @subtitle
end

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

The title that is displayed on the visual.

Returns:

See Also:



15463
15464
15465
 
# File 'quick_sight/cfn_template.rb', line 15463

def title
  @title
end

#visual_content_alt_text ⇒ String? (readonly)

The alt text for the visual.

Returns:

  • (String, nil)

See Also:



15468
15469
15470
 
# File 'quick_sight/cfn_template.rb', line 15468

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:



15433
15434
15435
 
# File 'quick_sight/cfn_template.rb', line 15433

def visual_id
  @visual_id
end

Class Method Details

.jsii_properties ⇒ Object 



15470
15471
15472
15473
15474
15475
15476
15477
15478
15479
15480
15481
 
# File 'quick_sight/cfn_template.rb', line 15470

def self.jsii_properties
  {
    :visual_id => "visualId",
    :actions => "actions",
    :chart_configuration => "chartConfiguration",
    :column_hierarchies => "columnHierarchies",
    :conditional_formatting => "conditionalFormatting",
    :subtitle => "subtitle",
    :title => "title",
    :visual_content_alt_text => "visualContentAltText",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



15483
15484
15485
15486
15487
15488
15489
15490
15491
15492
15493
15494
15495
15496
 
# File 'quick_sight/cfn_template.rb', line 15483

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