Class CfnUserPool.AdminCreateUserConfigProperty.Builder
java.lang.Object
software.amazon.awscdk.services.cognito.CfnUserPool.AdminCreateUserConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPool.AdminCreateUserConfigProperty>
- Enclosing interface:
CfnUserPool.AdminCreateUserConfigProperty
@Stability(Stable)
public static final class CfnUserPool.AdminCreateUserConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPool.AdminCreateUserConfigProperty>
A builder for
CfnUserPool.AdminCreateUserConfigProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()build()Builds the configured instance.inviteMessageTemplate(IResolvable inviteMessageTemplate) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()inviteMessageTemplate(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()unusedAccountValidityDays(Number unusedAccountValidityDays) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getUnusedAccountValidityDays()
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowAdminCreateUserOnly
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()- Parameters:
allowAdminCreateUserOnly- The setting for allowing self-service sign-up. Whentrue, only administrators can create new user profiles. Whenfalse, users can register themselves and create a new user profile with the SignUp operation.- Returns:
this
-
allowAdminCreateUserOnly
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()- Parameters:
allowAdminCreateUserOnly- The setting for allowing self-service sign-up. Whentrue, only administrators can create new user profiles. Whenfalse, users can register themselves and create a new user profile with the SignUp operation.- Returns:
this
-
inviteMessageTemplate
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(IResolvable inviteMessageTemplate) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()- Parameters:
inviteMessageTemplate- The template for the welcome message to new users. See also Customizing User Invitation Messages .- Returns:
this
-
inviteMessageTemplate
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()- Parameters:
inviteMessageTemplate- The template for the welcome message to new users. See also Customizing User Invitation Messages .- Returns:
this
-
unusedAccountValidityDays
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder unusedAccountValidityDays(Number unusedAccountValidityDays) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getUnusedAccountValidityDays()- Parameters:
unusedAccountValidityDays- This parameter is no longer in use. Configure the duration of temporary passwords with theTemporaryPasswordValidityDaysparameter of PasswordPolicyType . For older user pools that have aUnusedAccountValidityDaysconfiguration, that value is effective until you set a value forTemporaryPasswordValidityDays.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
AdminCreateUseragain, specifyingRESENDfor theMessageActionparameter.The default value for this parameter is 7.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnUserPool.AdminCreateUserConfigProperty>- Returns:
- a new instance of
CfnUserPool.AdminCreateUserConfigProperty - Throws:
NullPointerException- if any required attribute was not provided
-