Class: AWSCDK::QuickSight::CfnTemplate::CustomContentConfigurationProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::QuickSight::CfnTemplate::CustomContentConfigurationProperty

Defined in:

quick_sight/cfn_template.rb

Overview

The configuration of a CustomContentVisual .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html

Instance Attribute Summary

• #content_type ⇒ String^? readonly

  The content type of the custom content visual.

• #content_url ⇒ String^? readonly

  The input URL that links to the custom content that you want in the custom visual.

• #image_scaling ⇒ String^? readonly

  The sizing options for the size of the custom content visual.

• #interactions ⇒ AWSCDK::IResolvable, ... readonly

  The general visual interactions setup for a visual.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(content_type: nil, content_url: nil, image_scaling: nil, interactions: nil) ⇒ CustomContentConfigurationProperty constructor

  A new instance of CustomContentConfigurationProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(content_type: nil, content_url: nil, image_scaling: nil, interactions: nil) ⇒ CustomContentConfigurationProperty

Returns a new instance of CustomContentConfigurationProperty.

Parameters:

• content_type (String, nil) (defaults to: nil) —

  The content type of the custom content visual.

• content_url (String, nil) (defaults to: nil) —

  The input URL that links to the custom content that you want in the custom visual.

• image_scaling (String, nil) (defaults to: nil) —

  The sizing options for the size of the custom content visual.

• interactions (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::VisualInteractionOptionsProperty, nil) (defaults to: nil) —

  The general visual interactions setup for a visual.

# File 'quick_sight/cfn_template.rb', line 5574

def initialize(content_type: nil, content_url: nil, image_scaling: nil, interactions: nil)
  @content_type = content_type
  Jsii::Type.check_type(@content_type, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentType") unless @content_type.nil?
  @content_url = content_url
  Jsii::Type.check_type(@content_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contentUrl") unless @content_url.nil?
  @image_scaling = image_scaling
  Jsii::Type.check_type(@image_scaling, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "imageScaling") unless @image_scaling.nil?
  @interactions = interactions.is_a?(Hash) ? ::AWSCDK::QuickSight::CfnTemplate::VisualInteractionOptionsProperty.new(**interactions.transform_keys(&:to_sym)) : interactions
  Jsii::Type.check_type(@interactions, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19xdWlja3NpZ2h0LkNmblRlbXBsYXRlLlZpc3VhbEludGVyYWN0aW9uT3B0aW9uc1Byb3BlcnR5In1dfX0=")), "interactions") unless @interactions.nil?
end

Instance Attribute Details

#content_type ⇒ String^? (readonly)

The content type of the custom content visual.

You can use this to have the visual render as an image.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenttype

# File 'quick_sight/cfn_template.rb', line 5591

def content_type
  @content_type
end

#content_url ⇒ String^? (readonly)

The input URL that links to the custom content that you want in the custom visual.

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-contenturl

# File 'quick_sight/cfn_template.rb', line 5596

def content_url
  @content_url
end

#image_scaling ⇒ String^? (readonly)

The sizing options for the size of the custom content visual.

This structure is required when the ContentType of the visual is 'IMAGE' .

Returns:

• (String, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-imagescaling

# File 'quick_sight/cfn_template.rb', line 5603

def image_scaling
  @image_scaling
end

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

The general visual interactions setup for a visual.

Returns:

• (AWSCDK::IResolvable, AWSCDK::QuickSight::CfnTemplate::VisualInteractionOptionsProperty, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-quicksight-template-customcontentconfiguration.html#cfn-quicksight-template-customcontentconfiguration-interactions

# File 'quick_sight/cfn_template.rb', line 5608

def interactions
  @interactions
end

Class Method Details

.jsii_properties ⇒ Object

# File 'quick_sight/cfn_template.rb', line 5610

def self.jsii_properties
  {
    :content_type => "contentType",
    :content_url => "contentUrl",
    :image_scaling => "imageScaling",
    :interactions => "interactions",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'quick_sight/cfn_template.rb', line 5619

def to_jsii
  result = {}
  result.merge!({
    "contentType" => @content_type,
    "contentUrl" => @content_url,
    "imageScaling" => @image_scaling,
    "interactions" => @interactions,
  })
  result.compact
end