Class: AWSCDK::WorkspacesWeb::CfnUserSettings::LocalizedBrandingStringsProperty

Inherits:

Jsii::Struct

Object
Jsii::Struct
AWSCDK::WorkspacesWeb::CfnUserSettings::LocalizedBrandingStringsProperty

show all

Defined in:: workspaces_web/cfn_user_settings.rb

Overview

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

Instance Attribute Summary collapse

#browser_tab_title ⇒ String readonly
The text displayed in the browser tab title.
#contact_button_text ⇒ String^? readonly
The text displayed on the contact button.
#contact_link ⇒ String^? readonly
A contact link URL.
#loading_text ⇒ String^? readonly
The text displayed during session loading.
#login_button_text ⇒ String^? readonly
The text displayed on the login button.
#login_description ⇒ String^? readonly
The description text for the login section.
#login_title ⇒ String^? readonly
The title text for the login section.
#welcome_text ⇒ String readonly
The welcome text displayed on the sign-in page.

Class Method Summary collapse

.jsii_properties ⇒ Object

Instance Method Summary collapse

#initialize(browser_tab_title:, welcome_text:, contact_button_text: nil, contact_link: nil, loading_text: nil, login_button_text: nil, login_description: nil, login_title: nil) ⇒ LocalizedBrandingStringsProperty constructor
A new instance of LocalizedBrandingStringsProperty.
#to_jsii ⇒ Object

Constructor Details

#initialize(browser_tab_title:, welcome_text:, contact_button_text: nil, contact_link: nil, loading_text: nil, login_button_text: nil, login_description: nil, login_title: nil) ⇒ `LocalizedBrandingStringsProperty`

Returns a new instance of LocalizedBrandingStringsProperty.

Parameters:

browser_tab_title (String) —
The text displayed in the browser tab title.
welcome_text (String) —
The welcome text displayed on the sign-in page.
contact_button_text (String, nil) (defaults to: nil) —
The text displayed on the contact button.
contact_link (String, nil) (defaults to: nil) —
A contact link URL.
loading_text (String, nil) (defaults to: nil) —
The text displayed during session loading.
login_button_text (String, nil) (defaults to: nil) —
The text displayed on the login button.
login_description (String, nil) (defaults to: nil) —
The description text for the login section.
login_title (String, nil) (defaults to: nil) —
The title text for the login section.

# File 'workspaces_web/cfn_user_settings.rb', line 1029

def initialize(browser_tab_title:, welcome_text:, contact_button_text: nil, contact_link: nil, loading_text: nil, login_button_text: nil, login_description: nil, login_title: nil)
  @browser_tab_title = browser_tab_title
  Jsii::Type.check_type(@browser_tab_title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "browserTabTitle")
  @welcome_text = welcome_text
  Jsii::Type.check_type(@welcome_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "welcomeText")
  @contact_button_text = contact_button_text
  Jsii::Type.check_type(@contact_button_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contactButtonText") unless @contact_button_text.nil?
  @contact_link = contact_link
  Jsii::Type.check_type(@contact_link, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "contactLink") unless @contact_link.nil?
  @loading_text = loading_text
  Jsii::Type.check_type(@loading_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loadingText") unless @loading_text.nil?
  @login_button_text = login_button_text
  Jsii::Type.check_type(@login_button_text, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loginButtonText") unless @login_button_text.nil?
  @login_description = login_description
  Jsii::Type.check_type(@login_description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loginDescription") unless @login_description.nil?
  @login_title = login_title
  Jsii::Type.check_type(@login_title, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "loginTitle") unless @login_title.nil?
end

Instance Attribute Details

#browser_tab_title ⇒ `String` (readonly)

The text displayed in the browser tab title.

Returns:

(String)

See Also:

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



1052
1053
1054

# File 'workspaces_web/cfn_user_settings.rb', line 1052

def browser_tab_title
  @browser_tab_title
end

#contact_button_text ⇒ `String`^? (readonly)

The text displayed on the contact button.

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

Returns:

(String, nil)

See Also:

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



1064
1065
1066

# File 'workspaces_web/cfn_user_settings.rb', line 1064

def contact_button_text
  @contact_button_text
end

#contact_link ⇒ `String`^? (readonly)

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.

Returns:

(String, nil)

See Also:

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



1071
1072
1073

# File 'workspaces_web/cfn_user_settings.rb', line 1071

def contact_link
  @contact_link
end

#loading_text ⇒ `String`^? (readonly)

The text displayed during session loading.

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

Returns:

(String, nil)

See Also:

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



1078
1079
1080

# File 'workspaces_web/cfn_user_settings.rb', line 1078

def loading_text
  @loading_text
end

#login_button_text ⇒ `String`^? (readonly)

The text displayed on the login button.

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

Returns:

(String, nil)

See Also:

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



1085
1086
1087

# File 'workspaces_web/cfn_user_settings.rb', line 1085

def login_button_text
  @login_button_text
end

#login_description ⇒ `String`^? (readonly)

The description text for the login section.

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

Returns:

(String, nil)

See Also:

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



1092
1093
1094

# File 'workspaces_web/cfn_user_settings.rb', line 1092

def login_description
  @login_description
end

#login_title ⇒ `String`^? (readonly)

The title text for the login section.

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

Returns:

(String, nil)

See Also:

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



1099
1100
1101

# File 'workspaces_web/cfn_user_settings.rb', line 1099

def login_title
  @login_title
end

#welcome_text ⇒ `String` (readonly)

The welcome text displayed on the sign-in page.

Returns:

(String)

See Also:

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



1057
1058
1059

# File 'workspaces_web/cfn_user_settings.rb', line 1057

def welcome_text
  @welcome_text
end

Class Method Details

.jsii_properties ⇒ `Object`

# File 'workspaces_web/cfn_user_settings.rb', line 1101

def self.jsii_properties
  {
    :browser_tab_title => "browserTabTitle",
    :welcome_text => "welcomeText",
    :contact_button_text => "contactButtonText",
    :contact_link => "contactLink",
    :loading_text => "loadingText",
    :login_button_text => "loginButtonText",
    :login_description => "loginDescription",
    :login_title => "loginTitle",
  }
end

Instance Method Details

#to_jsii ⇒ `Object`

# File 'workspaces_web/cfn_user_settings.rb', line 1114

def to_jsii
  result = {}
  result.merge!({
    "browserTabTitle" => @browser_tab_title,
    "welcomeText" => @welcome_text,
    "contactButtonText" => @contact_button_text,
    "contactLink" => @contact_link,
    "loadingText" => @loading_text,
    "loginButtonText" => @login_button_text,
    "loginDescription" => @login_description,
    "loginTitle" => @login_title,
  })
  result.compact
end

Class: AWSCDK::WorkspacesWeb::CfnUserSettings::LocalizedBrandingStringsProperty

Overview

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(browser_tab_title:, welcome_text:, contact_button_text: nil, contact_link: nil, loading_text: nil, login_button_text: nil, login_description: nil, login_title: nil) ⇒ LocalizedBrandingStringsProperty

Instance Attribute Details

#browser_tab_title ⇒ String (readonly)

#contact_button_text ⇒ String? (readonly)

#contact_link ⇒ String? (readonly)

#loading_text ⇒ String? (readonly)

#login_button_text ⇒ String? (readonly)

#login_description ⇒ String? (readonly)

#login_title ⇒ String? (readonly)

#welcome_text ⇒ String (readonly)

Class Method Details

.jsii_properties ⇒ Object

Instance Method Details

#to_jsii ⇒ Object

#initialize(browser_tab_title:, welcome_text:, contact_button_text: nil, contact_link: nil, loading_text: nil, login_button_text: nil, login_description: nil, login_title: nil) ⇒ `LocalizedBrandingStringsProperty`

#browser_tab_title ⇒ `String` (readonly)

#contact_button_text ⇒ `String`^? (readonly)

#contact_link ⇒ `String`^? (readonly)

#loading_text ⇒ `String`^? (readonly)

#login_button_text ⇒ `String`^? (readonly)

#login_description ⇒ `String`^? (readonly)

#login_title ⇒ `String`^? (readonly)

#welcome_text ⇒ `String` (readonly)

.jsii_properties ⇒ `Object`

#to_jsii ⇒ `Object`