Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Synopsis
- data DefaultClientBrandingAttributes = DefaultClientBrandingAttributes' {
- forgotPasswordLink :: Maybe Text
- loginMessage :: Maybe (HashMap Text Text)
- logoUrl :: Maybe Text
- supportEmail :: Maybe Text
- supportLink :: Maybe Text
- newDefaultClientBrandingAttributes :: DefaultClientBrandingAttributes
- defaultClientBrandingAttributes_forgotPasswordLink :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_loginMessage :: Lens' DefaultClientBrandingAttributes (Maybe (HashMap Text Text))
- defaultClientBrandingAttributes_logoUrl :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_supportEmail :: Lens' DefaultClientBrandingAttributes (Maybe Text)
- defaultClientBrandingAttributes_supportLink :: Lens' DefaultClientBrandingAttributes (Maybe Text)
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.
DefaultClientBrandingAttributes' | |
|
Instances
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
andSupportLink
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
andSupportLink
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
andSupportLink
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
andSupportLink
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
.