software.amazon.awscdk.services.cognito

Interface CfnUserPool.AdminCreateUserConfigProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.AdminCreateUserConfigProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserPool.AdminCreateUserConfigProperty.Builder A builder for CfnUserPool.AdminCreateUserConfigProperty
static class	CfnUserPool.AdminCreateUserConfigProperty.Jsii$Proxy An implementation for CfnUserPool.AdminCreateUserConfigProperty

Method Summary

Modifier and Type	Method and Description
static CfnUserPool.AdminCreateUserConfigProperty.Builder	builder()
default Object	getAllowAdminCreateUserOnly() Set to `True` if only the administrator is allowed to create user profiles.
default Object	getInviteMessageTemplate() The message template to be used for the welcome message to new users.
default Number	getUnusedAccountValidityDays() 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 Detail

getAllowAdminCreateUserOnly

@Stability(value=Stable)
 @Nullable
default Object getAllowAdminCreateUserOnly()

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.

getInviteMessageTemplate

@Stability(value=Stable)
 @Nullable
default Object getInviteMessageTemplate()

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

See also Customizing User Invitation Messages .

getUnusedAccountValidityDays

@Stability(value=Stable)
 @Nullable
default Number 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 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 no longer be an available parameter for that user pool.

builder

@Stability(value=Stable)
static CfnUserPool.AdminCreateUserConfigProperty.Builder builder()

Returns:

a CfnUserPool.AdminCreateUserConfigProperty.Builder of CfnUserPool.AdminCreateUserConfigProperty