Class: Aws::WorkSpacesWeb::Types::BrandingConfiguration

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

Overview

The branding configuration output including custom images metadata, localized strings, color theme, and terms of service.

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.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

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

#favicon ⇒ Types::ImageMetadata

Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.

Returns:



332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

class BrandingConfiguration < 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 languages, allowing the portal to display content in the user's preferred language.

Returns:



332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

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

#logo ⇒ Types::ImageMetadata

Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.

Returns:



332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

class BrandingConfiguration < 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 that users must accept before accessing the portal.

Returns:

  • (String) 


332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

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

#wallpaper ⇒ Types::ImageMetadata

Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.

Returns:



332
333
334
335
336
337
338
339
340
341
 
# File 'gems/aws-sdk-workspacesweb/lib/aws-sdk-workspacesweb/types.rb', line 332

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