Class: AWSCDK::WorkspacesWeb::CfnUserSettings::BrandingConfigurationProperty

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
workspaces_web/cfn_user_settings.rb

Overview

The branding configuration that customizes the appearance of the web portal for end users.

This includes a custom logo, favicon, wallpaper, localized strings, color theme, and an optional terms of service.

The LogoMetadata , FaviconMetadata , and WallpaperMetadata properties are read-only and cannot be specified in your template. They are automatically populated by the service after you upload images and can be retrieved using the Fn::GetAtt intrinsic function.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(color_theme: nil, favicon: nil, favicon_metadata: nil, localized_strings: nil, logo: nil, logo_metadata: nil, terms_of_service: nil, wallpaper: nil, wallpaper_metadata: nil) ⇒ BrandingConfigurationProperty

Returns a new instance of BrandingConfigurationProperty.

Parameters:



754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
 
# File 'workspaces_web/cfn_user_settings.rb', line 754

def initialize(color_theme: nil, favicon: nil, favicon_metadata: nil, localized_strings: nil, logo: nil, logo_metadata: nil, terms_of_service: nil, wallpaper: nil, wallpaper_metadata: nil)
  @color_theme = color_theme
  Jsii::Type.check_type(@color_theme, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "colorTheme") unless @color_theme.nil?
  @favicon = favicon
  Jsii::Type.check_type(@favicon, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "favicon") unless @favicon.nil?
  @favicon_metadata = favicon_metadata.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::ImageMetadataProperty.new(**favicon_metadata.transform_keys(&:to_sym)) : favicon_metadata
  Jsii::Type.check_type(@favicon_metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5JbWFnZU1ldGFkYXRhUHJvcGVydHkifV19fQ==")), "faviconMetadata") unless @favicon_metadata.nil?
  @localized_strings = localized_strings
  Jsii::Type.check_type(@localized_strings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfd29ya3NwYWNlc3dlYi5DZm5Vc2VyU2V0dGluZ3MuTG9jYWxpemVkQnJhbmRpbmdTdHJpbmdzUHJvcGVydHkifV19fSwia2luZCI6Im1hcCJ9fV19fQ==")), "localizedStrings") unless @localized_strings.nil?
  @logo = 
  Jsii::Type.check_type(@logo, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "logo") unless @logo.nil?
  @logo_metadata = logo_metadata.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::ImageMetadataProperty.new(**logo_metadata.transform_keys(&:to_sym)) : logo_metadata
  Jsii::Type.check_type(@logo_metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5JbWFnZU1ldGFkYXRhUHJvcGVydHkifV19fQ==")), "logoMetadata") unless @logo_metadata.nil?
  @terms_of_service = terms_of_service
  Jsii::Type.check_type(@terms_of_service, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "termsOfService") unless @terms_of_service.nil?
  @wallpaper = wallpaper
  Jsii::Type.check_type(@wallpaper, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "wallpaper") unless @wallpaper.nil?
  @wallpaper_metadata = wallpaper_metadata.is_a?(Hash) ? ::AWSCDK::WorkspacesWeb::CfnUserSettings::ImageMetadataProperty.new(**wallpaper_metadata.transform_keys(&:to_sym)) : wallpaper_metadata
  Jsii::Type.check_type(@wallpaper_metadata, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c193b3Jrc3BhY2Vzd2ViLkNmblVzZXJTZXR0aW5ncy5JbWFnZU1ldGFkYXRhUHJvcGVydHkifV19fQ==")), "wallpaperMetadata") unless @wallpaper_metadata.nil?
end

Instance Attribute Details

#color_theme ⇒ String? (readonly)

The color theme for components on the web portal.

Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

Returns:

  • (String, nil)

See Also:



781
782
783
 
# File 'workspaces_web/cfn_user_settings.rb', line 781

def color_theme
  @color_theme
end

#favicon ⇒ String? (readonly)

The favicon image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

Returns:

  • (String, nil)

See Also:



788
789
790
 
# File 'workspaces_web/cfn_user_settings.rb', line 788

def favicon
  @favicon
end

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

Read-only.

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:

See Also:



795
796
797
 
# File 'workspaces_web/cfn_user_settings.rb', line 795

def favicon_metadata
  @favicon_metadata
end

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

A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.

Returns:

See Also:



800
801
802
 
# File 'workspaces_web/cfn_user_settings.rb', line 800

def localized_strings
  @localized_strings
end

#logo ⇒ String? (readonly)

The logo image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 100 KB in JPEG, PNG, or ICO format.

Returns:

  • (String, nil)

See Also:



807
808
809
 
# File 'workspaces_web/cfn_user_settings.rb', line 807

def 
  @logo
end

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

Read-only.

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:

See Also:



814
815
816
 
# File 'workspaces_web/cfn_user_settings.rb', line 814

def logo_metadata
  @logo_metadata
end

#terms_of_service ⇒ String? (readonly)

The terms of service text in Markdown format that users must accept before accessing the portal.

Returns:

  • (String, nil)

See Also:



819
820
821
 
# File 'workspaces_web/cfn_user_settings.rb', line 819

def terms_of_service
  @terms_of_service
end

#wallpaper ⇒ String? (readonly)

The wallpaper image for the portal.

Provide either a binary image file or an S3 URI pointing to the image file. Maximum 5 MB in JPEG or PNG format.

Returns:

  • (String, nil)

See Also:



826
827
828
 
# File 'workspaces_web/cfn_user_settings.rb', line 826

def wallpaper
  @wallpaper
end

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

Read-only.

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp. This property is automatically populated by the service and cannot be specified in your template. It can be retrieved using the Fn::GetAtt intrinsic function.

Returns:

See Also:



833
834
835
 
# File 'workspaces_web/cfn_user_settings.rb', line 833

def wallpaper_metadata
  @wallpaper_metadata
end

Class Method Details

.jsii_properties ⇒ Object 



835
836
837
838
839
840
841
842
843
844
845
846
847
 
# File 'workspaces_web/cfn_user_settings.rb', line 835

def self.jsii_properties
  {
    :color_theme => "colorTheme",
    :favicon => "favicon",
    :favicon_metadata => "faviconMetadata",
    :localized_strings => "localizedStrings",
    :logo => "logo",
    :logo_metadata => "logoMetadata",
    :terms_of_service => "termsOfService",
    :wallpaper => "wallpaper",
    :wallpaper_metadata => "wallpaperMetadata",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
 
# File 'workspaces_web/cfn_user_settings.rb', line 849

def to_jsii
  result = {}
  result.merge!({
    "colorTheme" => @color_theme,
    "favicon" => @favicon,
    "faviconMetadata" => @favicon_metadata,
    "localizedStrings" => @localized_strings,
    "logo" => @logo,
    "logoMetadata" => @logo_metadata,
    "termsOfService" => @terms_of_service,
    "wallpaper" => @wallpaper,
    "wallpaperMetadata" => @wallpaper_metadata,
  })
  result.compact
end