Class CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder
java.lang.Object
software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnUserPoolPropsMixin.AdminCreateUserConfigProperty>
- Enclosing interface:
CfnUserPoolPropsMixin.AdminCreateUserConfigProperty
@Stability(Stable)
public static final class CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnUserPoolPropsMixin.AdminCreateUserConfigProperty>
A builder for
CfnUserPoolPropsMixin.AdminCreateUserConfigProperty-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionallowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly) build()Builds the configured instance.inviteMessageTemplate(CfnUserPoolPropsMixin.InviteMessageTemplateProperty inviteMessageTemplate) inviteMessageTemplate(IResolvable inviteMessageTemplate) unusedAccountValidityDays(Number unusedAccountValidityDays)
-
Constructor Details
-
Builder
public Builder()
-
-
Method Details
-
allowAdminCreateUserOnly
@Stability(Stable) public CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) - 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 theSignUpoperation.- Returns:
this
-
allowAdminCreateUserOnly
@Stability(Stable) public CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly) - 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 theSignUpoperation.- Returns:
this
-
inviteMessageTemplate
@Stability(Stable) public CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(IResolvable inviteMessageTemplate) - Parameters:
inviteMessageTemplate- 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 .
- Returns:
this
-
inviteMessageTemplate
@Stability(Stable) public CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(CfnUserPoolPropsMixin.InviteMessageTemplateProperty inviteMessageTemplate) - Parameters:
inviteMessageTemplate- 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 .
- Returns:
this
-
unusedAccountValidityDays
@Stability(Stable) public CfnUserPoolPropsMixin.AdminCreateUserConfigProperty.Builder unusedAccountValidityDays(Number unusedAccountValidityDays) Sets the value ofCfnUserPoolPropsMixin.AdminCreateUserConfigProperty.getUnusedAccountValidityDays()- Parameters:
unusedAccountValidityDays- This parameter is no longer in use. 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 callAdminCreateUseragain, specifyingRESENDfor theMessageActionparameter.The default value for this parameter is 7.
- Returns:
this
-
build
Builds the configured instance.- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<CfnUserPoolPropsMixin.AdminCreateUserConfigProperty>- Returns:
- a new instance of
CfnUserPoolPropsMixin.AdminCreateUserConfigProperty - Throws:
NullPointerException- if any required attribute was not provided
-