BrandingConfigurationCreateInput - Amazon WorkSpaces Secure Browser
ContentsSee Also

BrandingConfigurationCreateInput

The input configuration for creating branding settings.

Contents

colorTheme

The color theme for components on the web portal. Choose Light if you upload a dark wallpaper, or Dark for a light wallpaper.

Type: String

Valid Values: Light | Dark

Required: Yes

favicon

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.

Type: IconImageInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

localizedStrings

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

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-TW

Required: Yes

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.

Type: IconImageInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

wallpaper

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.

Type: WallpaperImageInput object

Note: This object is a Union. Only one member of this object can be specified or returned.

Required: Yes

termsOfService

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

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: