Interface CfnUserPool.AdminCreateUserConfigProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnUserPool.AdminCreateUserConfigProperty.Jsii$Proxy
- Enclosing class:
CfnUserPool
@Stability(Stable)
public static interface CfnUserPool.AdminCreateUserConfigProperty
extends software.amazon.jsii.JsiiSerializable
The configuration for
AdminCreateUser
requests.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.cognito.*; AdminCreateUserConfigProperty adminCreateUserConfigProperty = AdminCreateUserConfigProperty.builder() .allowAdminCreateUserOnly(false) .inviteMessageTemplate(InviteMessageTemplateProperty.builder() .emailMessage("emailMessage") .emailSubject("emailSubject") .smsMessage("smsMessage") .build()) .unusedAccountValidityDays(123) .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnUserPool.AdminCreateUserConfigProperty
static final class
An implementation forCfnUserPool.AdminCreateUserConfigProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
Set toTrue
if only the administrator is allowed to create user profiles.default Object
The message template to be used for the welcome message to new users.default Number
The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAllowAdminCreateUserOnly
Set toTrue
if only the administrator is allowed to create user profiles.Set to
False
if users can sign themselves up via an app.- See Also:
-
getInviteMessageTemplate
The message template to be used for the welcome message to new users.See also Customizing User Invitation Messages .
- See Also:
-
getUnusedAccountValidityDays
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 theMessageAction
parameter. The default value for this parameter is 7.If you set a value for
TemporaryPasswordValidityDays
inPasswordPolicy
, that value will be used, andUnusedAccountValidityDays
will be no longer be an available parameter for that user pool.- See Also:
-
builder
-