Class: AWSCDK::QuickSight::CfnTemplate::SheetImageProperty

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

Overview

An image that is located on a sheet.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(sheet_image_id:, source:, actions: nil, image_content_alt_text: nil, interactions: nil, scaling: nil, tooltip: nil) ⇒ SheetImageProperty

Returns a new instance of SheetImageProperty.

Parameters:



24438
24439
24440
24441
24442
24443
24444
24445
24446
24447
24448
24449
24450
24451
24452
24453
 
# File 'quick_sight/cfn_template.rb', line 24438

def initialize(sheet_image_id:, source:, actions: nil, image_content_alt_text: nil, interactions: nil, scaling: nil, tooltip: nil)
  @sheet_image_id = sheet_image_id
  Jsii::Type.check_type(@sheet_image_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "sheetImageId")
  @source = source.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SheetImageSourceProperty.new(**source.transform_keys(&:to_sym)) : source
  Jsii::Type.check_type(@source, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNoZWV0SW1hZ2VTb3VyY2VQcm9wZXJ0eSJ9XX19")), "source")
  @actions = actions
  Jsii::Type.check_type(@actions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfcXVpY2tzaWdodC5DZm5UZW1wbGF0ZS5JbWFnZUN1c3RvbUFjdGlvblByb3BlcnR5In1dfX0sImtpbmQiOiJhcnJheSJ9fV19fQ==")), "actions") unless @actions.nil?
  @image_content_alt_text = image_content_alt_text
  Jsii::Type.check_type(@image_content_alt_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageContentAltText") unless @image_content_alt_text.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::ImageInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLkltYWdlSW50ZXJhY3Rpb25PcHRpb25zUHJvcGVydHkifV19fQ==")), "interactions") unless @interactions.nil?
  @scaling = scaling.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SheetImageScalingConfigurationProperty.new(**scaling.transform_keys(&:to_sym)) : scaling
  Jsii::Type.check_type(@scaling, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNoZWV0SW1hZ2VTY2FsaW5nQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "scaling") unless @scaling.nil?
  @tooltip = tooltip.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::SheetImageTooltipConfigurationProperty.new(**tooltip.transform_keys(&:to_sym)) : tooltip
  Jsii::Type.check_type(@tooltip, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlNoZWV0SW1hZ2VUb29sdGlwQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "tooltip") unless @tooltip.nil?
end

Instance Attribute Details

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

A list of custom actions that are configured for an image.

Returns:

See Also:



24469
24470
24471
 
# File 'quick_sight/cfn_template.rb', line 24469

def actions
  @actions
end

#image_content_alt_text ⇒ String? (readonly)

The alt text for the image.

Returns:

  • (String, nil)

See Also:



24474
24475
24476
 
# File 'quick_sight/cfn_template.rb', line 24474

def image_content_alt_text
  @image_content_alt_text
end

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

The general image interactions setup for an image.

Returns:

See Also:



24479
24480
24481
 
# File 'quick_sight/cfn_template.rb', line 24479

def interactions
  @interactions
end

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

Determines how the image is scaled.

Returns:

See Also:



24484
24485
24486
 
# File 'quick_sight/cfn_template.rb', line 24484

def scaling
  @scaling
end

#sheet_image_id ⇒ String (readonly)

The ID of the sheet image.

Returns:

  • (String)

See Also:



24459
24460
24461
 
# File 'quick_sight/cfn_template.rb', line 24459

def sheet_image_id
  @sheet_image_id
end

#source ⇒ AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::SheetImageSourceProperty (readonly)

The source of the image.

Returns:

See Also:



24464
24465
24466
 
# File 'quick_sight/cfn_template.rb', line 24464

def source
  @source
end

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

The tooltip to be shown when hovering over the image.

Returns:

See Also:



24489
24490
24491
 
# File 'quick_sight/cfn_template.rb', line 24489

def tooltip
  @tooltip
end

Class Method Details

.jsii_properties ⇒ Object 



24491
24492
24493
24494
24495
24496
24497
24498
24499
24500
24501
 
# File 'quick_sight/cfn_template.rb', line 24491

def self.jsii_properties
  {
    :sheet_image_id => "sheetImageId",
    :source => "source",
    :actions => "actions",
    :image_content_alt_text => "imageContentAltText",
    :interactions => "interactions",
    :scaling => "scaling",
    :tooltip => "tooltip",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



24503
24504
24505
24506
24507
24508
24509
24510
24511
24512
24513
24514
24515
 
# File 'quick_sight/cfn_template.rb', line 24503

def to_jsii
  result = {}
  result.merge!({
    "sheetImageId" => @sheet_image_id,
    "source" => @source,
    "actions" => @actions,
    "imageContentAltText" => @image_content_alt_text,
    "interactions" => @interactions,
    "scaling" => @scaling,
    "tooltip" => @tooltip,
  })
  result.compact
end