Class: Aws::WorkSpaces::Types::IosImportClientBrandingAttributes

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

Overview

Note:

When making an API call, you may pass IosImportClientBrandingAttributes data as a hash:

{
  logo: "data",
  logo_2x: "data",
  logo_3x: "data",
  support_email: "ClientEmail",
  support_link: "ClientUrl",
  forgot_password_link: "ClientUrl",
  login_message: {
    "ClientLocale" => "ClientLoginMessage",
  },
}

The client branding attributes to import for iOS device types. These attributes are displayed on the iOS client login screen.

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

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)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

#login_messageHash<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>)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

#logoString

The logo. This is the standard-resolution display that has a 1:1 pixel density (or @1x), where one pixel is equal to one point. The only image format accepted is a binary data object that is converted from a .png file.

Returns:

  • (String)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

#logo_2xString

The @2x version of the logo. This is the higher resolution display that offers a scale factor of 2.0 (or @2x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

Returns:

  • (String)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

#logo_3xString

The @3x version of the logo. This is the higher resolution display that offers a scale factor of 3.0 (or @3x). The only image format accepted is a binary data object that is converted from a .png file.

For more information about iOS image size and resolution, see Image Size and Resolution in the Apple Human Interface Guidelines.

Returns:

  • (String)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

#support_emailString

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)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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

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)


2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
# File 'gems/aws-sdk-workspaces/lib/aws-sdk-workspaces/types.rb', line 2718

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