interface LocalizedBrandingStringsProperty

Language	Type name
.NET	Amazon.CDK.AWS.WorkSpacesWeb.CfnUserSettings.LocalizedBrandingStringsProperty
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsworkspacesweb#CfnUserSettings_LocalizedBrandingStringsProperty
Java	software.amazon.awscdk.services.workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty
Python	aws_cdk.aws_workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty
TypeScript	aws-cdk-lib » aws_workspacesweb » CfnUserSettings » LocalizedBrandingStringsProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const localizedBrandingStringsProperty: workspacesweb.CfnUserSettings.LocalizedBrandingStringsProperty = {
  browserTabTitle: 'browserTabTitle',
  welcomeText: 'welcomeText',

  // the properties below are optional
  contactButtonText: 'contactButtonText',
  contactLink: 'contactLink',
  loadingText: 'loadingText',
  loginButtonText: 'loginButtonText',
  loginDescription: 'loginDescription',
  loginTitle: 'loginTitle',
};

Properties

Name	Type	Description
browserTabTitle	string	The text displayed in the browser tab title.
welcomeText	string	The welcome text displayed on the sign-in page.
contactButtonText?	string	The text displayed on the contact button.
contactLink?	string	A contact link URL.
loadingText?	string	The text displayed during session loading.
loginButtonText?	string	The text displayed on the login button.
loginDescription?	string	The description text for the login section.
loginTitle?	string	The title text for the login section.

---

browserTabTitle

Type: string

The text displayed in the browser tab title.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-browsertabtitle

---

welcomeText

Type: string

The welcome text displayed on the sign-in page.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-welcometext

---

contactButtonText?

Type: string (optional)

The text displayed on the contact button.

This field is optional and defaults to "Contact us".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactbuttontext

---

contactLink?

Type: string (optional)

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.

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-contactlink

---

loadingText?

Type: string (optional)

The text displayed during session loading.

This field is optional and defaults to "Loading your session".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-loadingtext

---

loginButtonText?

Type: string (optional)

The text displayed on the login button.

This field is optional and defaults to "Sign In".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-loginbuttontext

---

loginDescription?

Type: string (optional)

The description text for the login section.

This field is optional and defaults to "Sign in to your session".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-logindescription

---

loginTitle?

Type: string (optional)

The title text for the login section.

This field is optional and defaults to "Sign In".

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-workspacesweb-usersettings-localizedbrandingstrings.html#cfn-workspacesweb-usersettings-localizedbrandingstrings-logintitle