Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType

Description

Documentation

data AdminCreateUserConfigType Source #

The configuration for creating a new user profile.

See: newAdminCreateUserConfigType smart constructor.

Constructors

AdminCreateUserConfigType'

Fields

allowAdminCreateUserOnly :: Maybe Bool
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.
unusedAccountValidityDays :: Maybe Natural
The user account expiration limit, in days, after which the account 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 deprecated for that user pool.
inviteMessageTemplate :: Maybe MessageTemplateType
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.

Instances

Instances details

Eq AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods (==) :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool # (/=) :: AdminCreateUserConfigType -> AdminCreateUserConfigType -> Bool #
Read AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods readsPrec :: Int -> ReadS AdminCreateUserConfigType # readList :: ReadS [AdminCreateUserConfigType] # readPrec :: ReadPrec AdminCreateUserConfigType # readListPrec :: ReadPrec [AdminCreateUserConfigType] #
Show AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods showsPrec :: Int -> AdminCreateUserConfigType -> ShowS # show :: AdminCreateUserConfigType -> String # showList :: [AdminCreateUserConfigType] -> ShowS #
Generic AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Associated Types type Rep AdminCreateUserConfigType :: Type -> Type # Methods from :: AdminCreateUserConfigType -> Rep AdminCreateUserConfigType x # to :: Rep AdminCreateUserConfigType x -> AdminCreateUserConfigType #
NFData AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods rnf :: AdminCreateUserConfigType -> () #
Hashable AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods hashWithSalt :: Int -> AdminCreateUserConfigType -> Int # hash :: AdminCreateUserConfigType -> Int #
ToJSON AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods toJSON :: AdminCreateUserConfigType -> Value # toEncoding :: AdminCreateUserConfigType -> Encoding # toJSONList :: [AdminCreateUserConfigType] -> Value # toEncodingList :: [AdminCreateUserConfigType] -> Encoding #
FromJSON AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType Methods parseJSON :: Value -> Parser AdminCreateUserConfigType # parseJSONList :: Value -> Parser [AdminCreateUserConfigType] #
type Rep AdminCreateUserConfigType Source #
Instance details Defined in Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType type Rep AdminCreateUserConfigType = D1 ('MetaData "AdminCreateUserConfigType" "Amazonka.CognitoIdentityProvider.Types.AdminCreateUserConfigType" "libZSservicesZSamazonka-cognito-idpZSamazonka-cognito-idp" 'False) (C1 ('MetaCons "AdminCreateUserConfigType'" 'PrefixI 'True) (S1 ('MetaSel ('Just "allowAdminCreateUserOnly") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :: (S1 ('MetaSel ('Just "unusedAccountValidityDays") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "inviteMessageTemplate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MessageTemplateType)))))

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:unusedAccountValidityDays:AdminCreateUserConfigType', adminCreateUserConfigType_unusedAccountValidityDays - The user account expiration limit, in days, after which the account 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 deprecated for that user pool.

$sel:inviteMessageTemplate:AdminCreateUserConfigType', adminCreateUserConfigType_inviteMessageTemplate - The message template to be used for the welcome message to new users.

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_unusedAccountValidityDays :: Lens' AdminCreateUserConfigType (Maybe Natural) Source #

The user account expiration limit, in days, after which the account 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 deprecated for that user pool.

adminCreateUserConfigType_inviteMessageTemplate :: Lens' AdminCreateUserConfigType (Maybe MessageTemplateType) Source #

The message template to be used for the welcome message to new users.