AWS::WorkSpacesWeb::UserSettings LocalizedBrandingStrings - 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 LocalizedBrandingStrings

Localized text strings for a specific language that customize the web portal.

Syntax

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

JSON

{
  "BrowserTabTitle" : String,
  "ContactButtonText" : String,
  "ContactLink" : String,
  "LoadingText" : String,
  "LoginButtonText" : String,
  "LoginDescription" : String,
  "LoginTitle" : String,
  "WelcomeText" : String
}

YAML

  BrowserTabTitle: String
  ContactButtonText: String
  ContactLink: String
  LoadingText: String
  LoginButtonText: String
  LoginDescription: String
  LoginTitle: String
  WelcomeText: String

Properties

BrowserTabTitle

The text displayed in the browser tab title.

Required: Yes

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

ContactButtonText

The text displayed on the contact button. This field is optional and defaults to "Contact us".

Required: No

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

A contact link URL. The URL must start with https:// or mailto:. If not provided, the contact button will be hidden from the web portal screen.

Required: No

Type: String

Pattern: ^(https?://|mailto:).*

Update requires: No interruption

LoadingText

The text displayed during session loading. This field is optional and defaults to "Loading your session".

Required: No

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

LoginButtonText

The text displayed on the login button. This field is optional and defaults to "Sign In".

Required: No

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

LoginDescription

The description text for the login section. This field is optional and defaults to "Sign in to your session".

Required: No

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

LoginTitle

The title text for the login section. This field is optional and defaults to "Sign In".

Required: No

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption

WelcomeText

The welcome text displayed on the sign-in page.

Required: Yes

Type: String

Pattern: ^[^<>&'`~\\]*$

Update requires: No interruption