Package software.amazon.awscdk.services.workspacesweb

Interface CfnUserSettings.LocalizedBrandingStringsProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserSettings.LocalizedBrandingStringsProperty.Jsii$Proxy

Enclosing class:

CfnUserSettings

@Stability(Stable)
public static interface CfnUserSettings.LocalizedBrandingStringsProperty
extends software.amazon.jsii.JsiiSerializable

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.workspacesweb.*;
 LocalizedBrandingStringsProperty localizedBrandingStringsProperty = LocalizedBrandingStringsProperty.builder()
         .browserTabTitle("browserTabTitle")
         .welcomeText("welcomeText")
         // the properties below are optional
         .contactButtonText("contactButtonText")
         .contactLink("contactLink")
         .loadingText("loadingText")
         .loginButtonText("loginButtonText")
         .loginDescription("loginDescription")
         .loginTitle("loginTitle")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnUserSettings.LocalizedBrandingStringsProperty.Builder	A builder for CfnUserSettings.LocalizedBrandingStringsProperty
static final class	CfnUserSettings.LocalizedBrandingStringsProperty.Jsii$Proxy	An implementation for CfnUserSettings.LocalizedBrandingStringsProperty

Method Summary

Modifier and Type	Method	Description
static CfnUserSettings.LocalizedBrandingStringsProperty.Builder	builder()
String	getBrowserTabTitle()	The text displayed in the browser tab title.
default String	getContactButtonText()	The text displayed on the contact button.
default String	getContactLink()	A contact link URL.
default String	getLoadingText()	The text displayed during session loading.
default String	getLoginButtonText()	The text displayed on the login button.
default String	getLoginDescription()	The description text for the login section.
default String	getLoginTitle()	The title text for the login section.
String	getWelcomeText()	The welcome text displayed on the sign-in page.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBrowserTabTitle

@Stability(Stable)
@NotNull
String getBrowserTabTitle()

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

getWelcomeText

@Stability(Stable)
@NotNull
String getWelcomeText()

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

getContactButtonText

@Stability(Stable)
@Nullable
default String getContactButtonText()

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

getContactLink

@Stability(Stable)
@Nullable
default String getContactLink()

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

getLoadingText

@Stability(Stable)
@Nullable
default String getLoadingText()

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

getLoginButtonText

@Stability(Stable)
@Nullable
default String getLoginButtonText()

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

getLoginDescription

@Stability(Stable)
@Nullable
default String getLoginDescription()

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

getLoginTitle

@Stability(Stable)
@Nullable
default String getLoginTitle()

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

builder

@Stability(Stable)
static CfnUserSettings.LocalizedBrandingStringsProperty.Builder builder()

Returns:

a CfnUserSettings.LocalizedBrandingStringsProperty.Builder of CfnUserSettings.LocalizedBrandingStringsProperty