Class: AWSCDK::QBusiness::CfnWebExperience::CustomizationConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
q_business/cfn_web_experience.rb

Overview

Contains the configuration information to customize the logo, font, and color of an Amazon Q Business web experience with individual files for each property or a CSS file for them all.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(custom_css_url: nil, favicon_url: nil, font_url: nil, logo_url: nil) ⇒ CustomizationConfigurationProperty

Returns a new instance of CustomizationConfigurationProperty.

Parameters:

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

    Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.

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

    Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.

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

    Provides the URL where the custom font file is hosted for an Amazon Q web experience.

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

    Provides the URL where the custom logo file is hosted for an Amazon Q web experience.



732
733
734
735
736
737
738
739
740
741
 
# File 'q_business/cfn_web_experience.rb', line 732

def initialize(custom_css_url: nil, favicon_url: nil, font_url: nil, logo_url: nil)
  @custom_css_url = custom_css_url
  Jsii::Type.check_type(@custom_css_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "customCssUrl") unless @custom_css_url.nil?
  @favicon_url = favicon_url
  Jsii::Type.check_type(@favicon_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "faviconUrl") unless @favicon_url.nil?
  @font_url = font_url
  Jsii::Type.check_type(@font_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "fontUrl") unless @font_url.nil?
  @logo_url = logo_url
  Jsii::Type.check_type(@logo_url, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logoUrl") unless @logo_url.nil?
end

Instance Attribute Details

#custom_css_url ⇒ String? (readonly)

Provides the URL where the custom CSS file is hosted for an Amazon Q web experience.

Returns:

  • (String, nil)

See Also:



747
748
749
 
# File 'q_business/cfn_web_experience.rb', line 747

def custom_css_url
  @custom_css_url
end

#favicon_url ⇒ String? (readonly)

Provides the URL where the custom favicon file is hosted for an Amazon Q web experience.

Returns:

  • (String, nil)

See Also:



752
753
754
 
# File 'q_business/cfn_web_experience.rb', line 752

def favicon_url
  @favicon_url
end

#font_url ⇒ String? (readonly)

Provides the URL where the custom font file is hosted for an Amazon Q web experience.

Returns:

  • (String, nil)

See Also:



757
758
759
 
# File 'q_business/cfn_web_experience.rb', line 757

def font_url
  @font_url
end

#logo_url ⇒ String? (readonly)

Provides the URL where the custom logo file is hosted for an Amazon Q web experience.

Returns:

  • (String, nil)

See Also:



762
763
764
 
# File 'q_business/cfn_web_experience.rb', line 762

def logo_url
  @logo_url
end

Class Method Details

.jsii_properties ⇒ Object 



764
765
766
767
768
769
770
771
 
# File 'q_business/cfn_web_experience.rb', line 764

def self.jsii_properties
  {
    :custom_css_url => "customCssUrl",
    :favicon_url => "faviconUrl",
    :font_url => "fontUrl",
    :logo_url => "logoUrl",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



773
774
775
776
777
778
779
780
781
782
 
# File 'q_business/cfn_web_experience.rb', line 773

def to_jsii
  result = {}
  result.merge!({
    "customCssUrl" => @custom_css_url,
    "faviconUrl" => @favicon_url,
    "fontUrl" => @font_url,
    "logoUrl" => @logo_url,
  })
  result.compact
end