AWS::Cognito::UserPool AdminCreateUserConfig - AWS CloudFormation

AWS::Cognito::UserPool AdminCreateUserConfig

The configuration for AdminCreateUser requests.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

Properties

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.

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 AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

Note

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.

Required: No

Type: Integer

Minimum: 0

Maximum: 365

Update requires: No interruption