Class: Aws::WorkSpaces::Types::DefaultClientBrandingAttributes

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb

Overview

Returns default client branding attributes that were imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you don't include sensitive information.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

Returns:

  • (String) 


1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1349

class DefaultClientBrandingAttributes < Struct.new(
  :logo_url,
  :support_email,
  :support_link,
  :forgot_password_link,
  :login_message)
  SENSITIVE = []
  include Aws::Structure
end

#login_message ⇒ Hash<String,String>

The login message. Specified as a key value pair, in which the key is a locale and the value is the localized message for that locale. The only key supported is en_US. The HTML tags supported include the following: a, b, blockquote, br, cite, code, dd, dl, dt, div, em, i, li, ol, p, pre, q, small, span, strike, strong, sub, sup, u, ul.

Returns:

  • (Hash<String,String>) 


1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1349

class DefaultClientBrandingAttributes < Struct.new(
  :logo_url,
  :support_email,
  :support_link,
  :forgot_password_link,
  :login_message)
  SENSITIVE = []
  include Aws::Structure
end

#logo_url ⇒ String

The logo. The only image format accepted is a binary data object that is converted from a .png file.

Returns:

  • (String) 


1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1349

class DefaultClientBrandingAttributes < Struct.new(
  :logo_url,
  :support_email,
  :support_link,
  :forgot_password_link,
  :login_message)
  SENSITIVE = []
  include Aws::Structure
end

#support_email ⇒ String

The support email. The company's customer support email address.

* In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive. You can specify one parameter for each platform type, but not both.

  • The default email is workspaces-feedback@amazon.com.

Returns:

  • (String) 


1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1349

class DefaultClientBrandingAttributes < Struct.new(
  :logo_url,
  :support_email,
  :support_link,
  :forgot_password_link,
  :login_message)
  SENSITIVE = []
  include Aws::Structure
end

#support_link ⇒ String

The support link. The link for the company's customer support page for their WorkSpace.

* In each platform type, the SupportEmail and SupportLink parameters are mutually exclusive.You can specify one parameter for each platform type, but not both.

  • The default support link is workspaces-feedback@amazon.com.

Returns:

  • (String) 


1349
1350
1351
1352
1353
1354
1355
1356
1357
 
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 1349

class DefaultClientBrandingAttributes < Struct.new(
  :logo_url,
  :support_email,
  :support_link,
  :forgot_password_link,
  :login_message)
  SENSITIVE = []
  include Aws::Structure
end