Menu
AWS CloudFormation
User Guide (API Version 2010-05-15)

Amazon Cognito UserPool AdminCreateUserConfig

AdminCreateUserConfig is a property of the AWS::Cognito::UserPool resource. The AdminCreateUserConfig property configures the AdminCreateUser requests for an Amazon Cognito User Pool.

Syntax

JSON

Copy
{ "AllowAdminCreateUserOnly" : Boolean, "InviteMessageTemplate" : MessageTemplateType, "UnusedAccountValidityDays" : Number }

YAML

Copy
AllowAdminCreateUserOnly: Boolean InviteMessageTemplate: MessageTemplateType UnusedAccountValidityDays: Number

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.

Type: Boolean

Required: No

InviteMessageTemplate

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

Type: Amazon Cognito UserPool InviteMessageTemplate

Required: No

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.

Type: Number

Required: No

On this page: