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(value=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 and Description
Builder()

Method Summary

Modifier and Type	Method and 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(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate) Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getInviteMessageTemplate()
CfnUserPool.AdminCreateUserConfigProperty.Builder	inviteMessageTemplate(IResolvable 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 Detail

Builder

public Builder()

Method Detail

allowAdminCreateUserOnly

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

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()

Parameters:

allowAdminCreateUserOnly - Set to `True` if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

Returns:

this

allowAdminCreateUserOnly

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

Sets the value of CfnUserPool.AdminCreateUserConfigProperty.getAllowAdminCreateUserOnly()

Parameters:

allowAdminCreateUserOnly - Set to `True` if only the administrator is allowed to create user profiles. Set to False if users can sign themselves up via an app.

Returns:

this

inviteMessageTemplate

@Stability(value=Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(CfnUserPool.InviteMessageTemplateProperty inviteMessageTemplate)

Sets the value of CfnUserPool.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(value=Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder inviteMessageTemplate(IResolvable inviteMessageTemplate)

Sets the value of CfnUserPool.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(value=Stable)
public CfnUserPool.AdminCreateUserConfigProperty.Builder unusedAccountValidityDays(Number unusedAccountValidityDays)

Sets the value of CfnUserPool.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 call AdminCreateUser again, specifying "RESEND" for the MessageAction parameter. The default value for this parameter is 7.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy , that value will be used, and UnusedAccountValidityDays will be no longer be an available parameter for that user pool.

Returns:

this

build

@Stability(value=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