Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Documentation

data IosClientBrandingAttributes

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

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

See: newIosClientBrandingAttributes smart constructor.

Constructors

IosClientBrandingAttributes'

Fields

• forgotPasswordLink :: Maybe Text

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

• loginMessage :: Maybe (HashMap Text Text)

  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.

• logo2xUrl :: Maybe Text

  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.

• logo3xUrl :: Maybe Text

  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.

• logoUrl :: Maybe Text

  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.

• supportEmail :: Maybe Text

  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 [e-mail].
• supportLink :: Maybe Text

  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 [e-mail].

Instances

FromJSON IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

parseJSON :: Value -> Parser IosClientBrandingAttributes

parseJSONList :: Value -> Parser [IosClientBrandingAttributes]

Generic IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Associated Types

type Rep IosClientBrandingAttributes :: Type -> Type

Methods

from :: IosClientBrandingAttributes -> Rep IosClientBrandingAttributes x

to :: Rep IosClientBrandingAttributes x -> IosClientBrandingAttributes

Read IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

readsPrec :: Int -> ReadS IosClientBrandingAttributes

readList :: ReadS [IosClientBrandingAttributes]

readPrec :: ReadPrec IosClientBrandingAttributes

readListPrec :: ReadPrec [IosClientBrandingAttributes]

Show IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

showsPrec :: Int -> IosClientBrandingAttributes -> ShowS

show :: IosClientBrandingAttributes -> String

showList :: [IosClientBrandingAttributes] -> ShowS

NFData IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

rnf :: IosClientBrandingAttributes -> ()

Eq IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

(==) :: IosClientBrandingAttributes -> IosClientBrandingAttributes -> Bool

(/=) :: IosClientBrandingAttributes -> IosClientBrandingAttributes -> Bool

Hashable IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

Methods

hashWithSalt :: Int -> IosClientBrandingAttributes -> Int

hash :: IosClientBrandingAttributes -> Int

type Rep IosClientBrandingAttributes

Defined in Amazonka.WorkSpaces.Types.IosClientBrandingAttributes

type Rep IosClientBrandingAttributes = D1 ('MetaData "IosClientBrandingAttributes" "Amazonka.WorkSpaces.Types.IosClientBrandingAttributes" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "IosClientBrandingAttributes'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "forgotPasswordLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "loginMessage") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: S1 ('MetaSel ('Just "logo2xUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: ((S1 ('MetaSel ('Just "logo3xUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "logoUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "supportEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newIosClientBrandingAttributes :: IosClientBrandingAttributes

Create a value of IosClientBrandingAttributes with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:forgotPasswordLink:IosClientBrandingAttributes', iosClientBrandingAttributes_forgotPasswordLink - The forgotten password link. This is the web address that users can go to if they forget the password for their WorkSpace.

$sel:loginMessage:IosClientBrandingAttributes', iosClientBrandingAttributes_loginMessage - 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.

$sel:logo2xUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logo2xUrl - 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.

$sel:logo3xUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logo3xUrl - 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.

$sel:logoUrl:IosClientBrandingAttributes', iosClientBrandingAttributes_logoUrl - 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.

$sel:supportEmail:IosClientBrandingAttributes', iosClientBrandingAttributes_supportEmail - 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 [e-mail].

$sel:supportLink:IosClientBrandingAttributes', iosClientBrandingAttributes_supportLink - 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 [e-mail].

iosClientBrandingAttributes_forgotPasswordLink :: Lens' IosClientBrandingAttributes (Maybe Text)

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

iosClientBrandingAttributes_loginMessage :: Lens' IosClientBrandingAttributes (Maybe (HashMap Text Text))

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.

iosClientBrandingAttributes_logo2xUrl :: Lens' IosClientBrandingAttributes (Maybe Text)

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.

iosClientBrandingAttributes_logo3xUrl :: Lens' IosClientBrandingAttributes (Maybe Text)

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.

iosClientBrandingAttributes_logoUrl :: Lens' IosClientBrandingAttributes (Maybe Text)

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.

iosClientBrandingAttributes_supportEmail :: Lens' IosClientBrandingAttributes (Maybe Text)

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 [e-mail].

iosClientBrandingAttributes_supportLink :: Lens' IosClientBrandingAttributes (Maybe Text)

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 [e-mail].