AWS::WorkSpacesWeb::UserSettings BrandingConfiguration - Amazon CloudFormation
SyntaxProperties
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

This is the new Amazon CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the Amazon CloudFormation User Guide.

AWS::WorkSpacesWeb::UserSettings BrandingConfiguration

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.

Note

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.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{
  "ColorTheme" : String,
  "Favicon" : String,
  "FaviconMetadata" : ImageMetadata,
  "LocalizedStrings" : {Key: Value, ...},
  "Logo" : String,
  "LogoMetadata" : ImageMetadata,
  "TermsOfService" : String,
  "Wallpaper" : String,
  "WallpaperMetadata" : ImageMetadata
}

Properties

ColorTheme

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

Required: No

Type: String

Allowed values: Light | Dark

Update requires: No interruption

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.

Required: No

Type: String

Pattern: (^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)

Update requires: No interruption

FaviconMetadata

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.

Required: No

Type: ImageMetadata

Update requires: No interruption

LocalizedStrings

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

Required: No

Type: Object of LocalizedBrandingStrings

Update requires: No interruption

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.

Required: No

Type: String

Pattern: (^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)

Update requires: No interruption

LogoMetadata

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.

Required: No

Type: ImageMetadata

Update requires: No interruption

TermsOfService

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

Required: No

Type: String

Maximum: 153600

Update requires: No interruption

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.

Required: No

Type: String

Pattern: (^s3://[a-z0-9][a-z0-9\.\-]{1,61}[a-z0-9]/.+$)|(^(?=(.{4})*$)[A-Za-z0-9+/]*={0,2}$)

Update requires: No interruption

WallpaperMetadata

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.

Required: No

Type: ImageMetadata

Update requires: No interruption