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.DefaultClientBrandingAttributes

Description

 
Synopsis

Documentation

data DefaultClientBrandingAttributes Source #

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

Constructors

DefaultClientBrandingAttributes' 

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.

  • logoUrl :: Maybe Text

    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
FromJSON DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

Generic DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

Associated Types

type Rep DefaultClientBrandingAttributes :: Type -> Type #

Read DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

Show DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

NFData DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

Eq DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

Hashable DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

type Rep DefaultClientBrandingAttributes Source # 
Instance details

Defined in Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes

type Rep DefaultClientBrandingAttributes = D1 ('MetaData "DefaultClientBrandingAttributes" "Amazonka.WorkSpaces.Types.DefaultClientBrandingAttributes" "amazonka-workspaces-2.0-EI6zVIh1dgfFziJEJ0Fxkv" 'False) (C1 ('MetaCons "DefaultClientBrandingAttributes'" '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 "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))))))

newDefaultClientBrandingAttributes :: DefaultClientBrandingAttributes Source #

Create a value of DefaultClientBrandingAttributes 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:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_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:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_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:logoUrl:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_logoUrl - The logo. The only image format accepted is a binary data object that is converted from a .png file.

$sel:supportEmail:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_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:DefaultClientBrandingAttributes', defaultClientBrandingAttributes_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.

defaultClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultClientBrandingAttributes (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.

defaultClientBrandingAttributes_loginMessage :: Lens' DefaultClientBrandingAttributes (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.

defaultClientBrandingAttributes_logoUrl :: Lens' DefaultClientBrandingAttributes (Maybe Text) Source #

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

defaultClientBrandingAttributes_supportEmail :: Lens' DefaultClientBrandingAttributes (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.

defaultClientBrandingAttributes_supportLink :: Lens' DefaultClientBrandingAttributes (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.