Package 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(Stable)
public static interface CfnUserPool.AdminCreateUserConfigProperty
extends software.amazon.jsii.JsiiSerializable

The settings for administrator creation of users in a user pool.

Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.AdminCreateUserConfigProperty.Builder	builder()
default Object	getAllowAdminCreateUserOnly()	The setting for allowing self-service sign-up.
default Object	getInviteMessageTemplate()	The template for the welcome message to new users.
default Number	getUnusedAccountValidityDays()	This parameter is no longer in use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAllowAdminCreateUserOnly

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

The setting for allowing self-service sign-up.

When true , only administrators can create new user profiles. When false , users can register themselves and create a new user profile with the SignUp operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-allowadmincreateuseronly

getInviteMessageTemplate

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

The template for the welcome message to new users.

This template must include the {####} temporary password placeholder if you are creating users with passwords. If your users don't have passwords, you can omit the placeholder.

See also Customizing User Invitation Messages .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-invitemessagetemplate

getUnusedAccountValidityDays

@Stability(Stable)
@Nullable
default Number getUnusedAccountValidityDays()

This parameter is no longer in use.

Configure the duration of temporary passwords with the TemporaryPasswordValidityDays parameter of PasswordPolicyType . For older user pools that have a UnusedAccountValidityDays configuration, that value is effective until you set a value for TemporaryPasswordValidityDays .

The password expiration limit in days for administrator-created users. When this time expires, the user can't sign in with their temporary password. 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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-admincreateuserconfig.html#cfn-cognito-userpool-admincreateuserconfig-unusedaccountvaliditydays

builder

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

Returns:

a CfnUserPool.AdminCreateUserConfigProperty.Builder of CfnUserPool.AdminCreateUserConfigProperty