AWS::Cognito::UserPool AdminCreateUserConfig
The configuration for AdminCreateUser requests.
Syntax
To declare this entity in your Amazon CloudFormation template, use the following syntax:
JSON
{ "AllowAdminCreateUserOnly" :Boolean, "InviteMessageTemplate" :InviteMessageTemplate, "UnusedAccountValidityDays" :Integer}
YAML
AllowAdminCreateUserOnly:BooleanInviteMessageTemplate:InviteMessageTemplateUnusedAccountValidityDays:Integer
Properties
AllowAdminCreateUserOnly-
Set to
Trueif only the administrator is allowed to create user profiles. Set toFalseif users can sign themselves up via an app.Required: No
Type: Boolean
Update requires: No interruption
InviteMessageTemplate-
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
Required: No
Type: InviteMessageTemplate
Update requires: No interruption
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
AdminCreateUseragain, specifying"RESEND"for theMessageActionparameter. The default value for this parameter is 7.Note
If you set a value for
TemporaryPasswordValidityDaysinPasswordPolicy, that value will be used, andUnusedAccountValidityDayswill be no longer be an available parameter for that user pool.Required: No
Type: Integer
Minimum:
0Maximum:
365Update requires: No interruption