amazonka-workspaces-2.0: Amazon WorkSpaces SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Description

 
Synopsis

Documentation

data DefaultImportClientBrandingAttributes Source #

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: newDefaultImportClientBrandingAttributes smart constructor.

Constructors

DefaultImportClientBrandingAttributes' 

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.

  • :: Maybe Base64

    The logo. 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 workspaces-feedback@amazon.com.
  • 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 workspaces-feedback@amazon.com.

Instances

Instances details
ToJSON DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Generic DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Read DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Show DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

NFData DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Eq DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

Hashable DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

type Rep DefaultImportClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes

type Rep DefaultImportClientBrandingAttributes = D1 ('MetaData "DefaultImportClientBrandingAttributes" "Amazonka.WorkSpaces.Types.DefaultImportClientBrandingAttributes" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DefaultImportClientBrandingAttributes'" '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 "logo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Base64)) :*: (S1 ('MetaSel ('Just "supportEmail") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "supportLink") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))))

newDefaultImportClientBrandingAttributes :: DefaultImportClientBrandingAttributes Source #

Create a value of DefaultImportClientBrandingAttributes 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:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_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:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_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:logo:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_logo - The logo. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

$sel:supportEmail:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_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 workspaces-feedback@amazon.com.

$sel:supportLink:DefaultImportClientBrandingAttributes', defaultImportClientBrandingAttributes_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 workspaces-feedback@amazon.com.

defaultImportClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

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

defaultImportClientBrandingAttributes_loginMessage :: Lens' DefaultImportClientBrandingAttributes (Maybe (HashMap Text Text)) Source #

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.

:: Lens' DefaultImportClientBrandingAttributes (Maybe ByteString) Source #

The logo. The only image format accepted is a binary data object that is converted from a .png file.-- -- Note: This Lens automatically encodes and decodes Base64 data. -- The underlying isomorphism will encode to Base64 representation during -- serialisation, and decode from Base64 representation during deserialisation. -- This Lens accepts and returns only raw unencoded data.

defaultImportClientBrandingAttributes_supportEmail :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

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.

defaultImportClientBrandingAttributes_supportLink :: Lens' DefaultImportClientBrandingAttributes (Maybe Text) Source #

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.