BrandingConfiguration
The branding configuration output including custom images metadata, localized strings, color theme, and terms of service.
Contents
- colorTheme
-
The color theme for components on the web portal.
Type: String
Valid Values:
Light | DarkRequired: Yes
- favicon
-
Metadata for the favicon image file, including the MIME type, file extension, and upload timestamp.
Type: ImageMetadata object
Required: Yes
- localizedStrings
-
A map of localized text strings for different languages, allowing the portal to display content in the user's preferred language.
Type: String to LocalizedBrandingStrings object map
Valid Keys:
de-DE | en-US | es-ES | fr-FR | id-ID | it-IT | ja-JP | ko-KR | pt-BR | zh-CN | zh-TWRequired: Yes
- logo
-
Metadata for the logo image file, including the MIME type, file extension, and upload timestamp.
Type: ImageMetadata object
Required: Yes
- wallpaper
-
Metadata for the wallpaper image file, including the MIME type, file extension, and upload timestamp.
Type: ImageMetadata object
Required: Yes
- termsOfService
-
The terms of service text in Markdown format that users must accept before accessing the portal.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 153600.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
