Class: Aws::WorkSpacesWeb::Types::BrandingConfigurationCreateInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb

Overview

The input configuration for creating branding settings.

See Also:

Constant Summary collapse

SENSITIVE = 
[:terms_of_service]

Instance Attribute Summary collapse

Instance Attribute Details

#color_theme ⇒ String

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) 


382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end

#favicon ⇒ Types::IconImageInput

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:



382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end

#localized_strings ⇒ Hash<String,Types::LocalizedBrandingStrings>

A map of localized text strings for different supported languages. Each locale must provide the required fields browserTabTitle and welcomeText.

Returns:



382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end

#logo ⇒ Types::IconImageInput

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:



382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end

#terms_of_service ⇒ String

The terms of service text in Markdown format. Users will be presented with the terms of service after successfully signing in.

Returns:

  • (String) 


382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end

#wallpaper ⇒ Types::WallpaperImageInput

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. If not provided, a default wallpaper will be used as the background image.

Returns:



382
383
384
385
386
387
388
389
390
391
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 382

class BrandingConfigurationCreateInput < Struct.new(
  :logo,
  :wallpaper,
  :favicon,
  :localized_strings,
  :color_theme,
  :terms_of_service)
  SENSITIVE = [:terms_of_service]
  include Aws::Structure
end