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 AdminCreateUserConfigType = AdminCreateUserConfigType' {}
- newAdminCreateUserConfigType :: AdminCreateUserConfigType
- adminCreateUserConfigType_allowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool)
- adminCreateUserConfigType_inviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType)
- adminCreateUserConfigType_unusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural)
Documentation
data AdminCreateUserConfigType Source #
The configuration for creating a new user profile.
See: newAdminCreateUserConfigType
smart constructor.
AdminCreateUserConfigType' | |
|
Instances
newAdminCreateUserConfigType :: AdminCreateUserConfigType Source #
Create a value of AdminCreateUserConfigType
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:allowAdminCreateUserOnly:AdminCreateUserConfigType'
, adminCreateUserConfigType_allowAdminCreateUserOnly
- Set to True
if only the administrator is allowed to create user
profiles. Set to False
if users can sign themselves up via an app.
$sel:inviteMessageTemplate:AdminCreateUserConfigType'
, adminCreateUserConfigType_inviteMessageTemplate
- The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
$sel:unusedAccountValidityDays:AdminCreateUserConfigType'
, adminCreateUserConfigType_unusedAccountValidityDays
- The user account expiration limit, in days, after which a new account
that hasn't signed in is no longer usable. To reset the account after
that time limit, you must call AdminCreateUser
again, specifying
"RESEND"
for the MessageAction
parameter. The default value for
this parameter is 7.
If you set a value for TemporaryPasswordValidityDays
in
PasswordPolicy
, that value will be used, and
UnusedAccountValidityDays
will be no longer be an available parameter
for that user pool.
adminCreateUserConfigType_allowAdminCreateUserOnly :: Lens' AdminCreateUserConfigType (Maybe Bool) Source #
Set to True
if only the administrator is allowed to create user
profiles. Set to False
if users can sign themselves up via an app.
adminCreateUserConfigType_inviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType) Source #
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
adminCreateUserConfigType_unusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural) Source #
The user account expiration limit, in days, after which a new account
that hasn't signed in is no longer usable. To reset the account after
that time limit, you must call AdminCreateUser
again, specifying
"RESEND"
for the MessageAction
parameter. The default value for
this parameter is 7.
If you set a value for TemporaryPasswordValidityDays
in
PasswordPolicy
, that value will be used, and
UnusedAccountValidityDays
will be no longer be an available parameter
for that user pool.