Package software.amazon.awscdk.services.cognito

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

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnUserPool.AdminCreateUserConfigProperty.Builder	allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly)	Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()
CfnUserPool.AdminCreateUserConfigProperty.Builder	allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly)	Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()
CfnUserPool.AdminCreateUserConfigProperty	build()	Builds the configured instance.
CfnUserPool.AdminCreateUserConfigProperty.Builder	inviteMessageTemplate(IResolvable inviteMessageTemplate)	Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()
CfnUserPool.AdminCreateUserConfigProperty.Builder	inviteMessageTemplate(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate)	Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()
CfnUserPool.AdminCreateUserConfigProperty.Builder	unusedAccountValidityDays(Number unusedAccountValidityDays)	Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getUnusedAccountValidityDays()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

allowAdminCreateUserOnly

@Stability(Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly)

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()

Parameters:

allowAdminCreateUserOnly - 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.

Returns:

this

allowAdminCreateUserOnly

@Stability(Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder allowAdminCreateUserOnly(IResolvable allowAdminCreateUserOnly)

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()

Parameters:

allowAdminCreateUserOnly - 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.

Returns:

this

inviteMessageTemplate

@Stability(Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(IResolvable inviteMessageTemplate)

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()

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 CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate)

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()

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 CfnUserPool.AdminCreateUserConfigProperty.Builder unusedAccountValidityDays(Number unusedAccountValidityDays)

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getUnusedAccountValidityDays()

Parameters:

unusedAccountValidityDays - 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.

Returns:

this

build

@Stability(Stable)
public CfnUserPool.AdminCreateUserConfigProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnUserPool.AdminCreateUserConfigProperty>

Returns:

a new instance of CfnUserPool.AdminCreateUserConfigProperty

Throws:

NullPointerException - if any required attribute was not provided