Class: Aws::WorkSpaces::Types::DefaultImportClientBrandingAttributes

Inherits:

Struct

• Object
• Struct
• Aws::WorkSpaces::Types::DefaultImportClientBrandingAttributes

Includes:

Structure

Defined in:

lib/aws-sdk-workspaces/types.rb

Overview

The default client branding attributes to be imported. These attributes display on the client login screen.

Client branding attributes are public facing. Ensure that you do not include sensitive information.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #forgot_password_link ⇒ String

  The forgotten password link.

• #login_message ⇒ Hash<String,String>

  The login message.

• #logo ⇒ String

  The logo.

• #support_email ⇒ String

  The support email.

• #support_link ⇒ String

  The support link.

Instance Attribute Details

#forgot_password_link ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1184

class DefaultImportClientBrandingAttributes < Struct.new(
  :logo,
  :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>)

# File 'lib/aws-sdk-workspaces/types.rb', line 1184

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

#logo ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1184

class DefaultImportClientBrandingAttributes < Struct.new(
  :logo,
  :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.

<note markdown=“1”> * 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`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1184

class DefaultImportClientBrandingAttributes < Struct.new(
  :logo,
  :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.

<note markdown=“1”> * 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`.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-workspaces/types.rb', line 1184

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