Class: AWSCDK::Transfer::CfnWebApp::WebAppCustomizationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
transfer/cfn_web_app.rb

Overview

A structure that contains the customization fields for the web app.

You can provide a title, logo, and icon to customize the appearance of your web app.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(favicon_file: nil, logo_file: nil, title: nil) ⇒ WebAppCustomizationProperty

Returns a new instance of WebAppCustomizationProperty.

Parameters:

  • favicon_file (String, nil) (defaults to: nil)

    Returns an icon file data string (in base64 encoding).

  • logo_file (String, nil) (defaults to: nil)

    Returns a logo file data string (in base64 encoding).

  • title (String, nil) (defaults to: nil)

    Returns the page title that you defined for your web app.



770
771
772
773
774
775
776
777
# File 'transfer/cfn_web_app.rb', line 770

def initialize(favicon_file: nil, logo_file: nil, title: nil)
  @favicon_file = favicon_file
  Jsii::Type.check_type(@favicon_file, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "faviconFile") unless @favicon_file.nil?
  @logo_file = logo_file
  Jsii::Type.check_type(@logo_file, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logoFile") unless @logo_file.nil?
  @title = title
  Jsii::Type.check_type(@title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "title") unless @title.nil?
end

Instance Attribute Details

#favicon_fileString? (readonly)

Returns an icon file data string (in base64 encoding).



783
784
785
# File 'transfer/cfn_web_app.rb', line 783

def favicon_file
  @favicon_file
end

#logo_fileString? (readonly)

Returns a logo file data string (in base64 encoding).



788
789
790
# File 'transfer/cfn_web_app.rb', line 788

def logo_file
  @logo_file
end

#titleString? (readonly)

Returns the page title that you defined for your web app.



793
794
795
# File 'transfer/cfn_web_app.rb', line 793

def title
  @title
end

Class Method Details

.jsii_propertiesObject



795
796
797
798
799
800
801
# File 'transfer/cfn_web_app.rb', line 795

def self.jsii_properties
  {
    :favicon_file => "faviconFile",
    :logo_file => "logoFile",
    :title => "title",
  }
end

Instance Method Details

#to_jsiiObject



803
804
805
806
807
808
809
810
811
# File 'transfer/cfn_web_app.rb', line 803

def to_jsii
  result = {}
  result.merge!({
    "faviconFile" => @favicon_file,
    "logoFile" => @logo_file,
    "title" => @title,
  })
  result.compact
end