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
- Set toTrue
if only the administrator is allowed to create user profiles. Set toFalse
if users can sign themselves up via an app.- Returns:
this
-
allowAdminCreateUserOnly
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()
- Parameters:
allowAdminCreateUserOnly
- Set toTrue
if only the administrator is allowed to create user profiles. Set toFalse
if users can sign themselves up via an app.- Returns:
this
-
inviteMessageTemplate
@Stability(Stable) public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(IResolvable inviteMessageTemplate) Sets the value ofCfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()
- Parameters:
inviteMessageTemplate
- The message template to be used 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 message template to be used 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
- 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 callAdminCreateUser
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.- Returns:
this
-
build
Builds the configured instance.- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnUserPool.AdminCreateUserConfigProperty>
- Returns:
- a new instance of
CfnUserPool.AdminCreateUserConfigProperty
- Throws:
NullPointerException
- if any required attribute was not provided
-