software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminCreateUserConfigType.Builder

All Superinterfaces:

Buildable, CopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>, SdkBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>, SdkPojo

Enclosing class:

AdminCreateUserConfigType

public static interface AdminCreateUserConfigType.Builder
extends SdkPojo, CopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

Method Summary

Modifier and Type	Method and Description
AdminCreateUserConfigType.Builder	allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) Set to True if only the administrator is allowed to create user profiles.
default AdminCreateUserConfigType.Builder	inviteMessageTemplate(Consumer<MessageTemplateType.Builder> inviteMessageTemplate) The message template to be used for the welcome message to new users.
AdminCreateUserConfigType.Builder	inviteMessageTemplate(MessageTemplateType inviteMessageTemplate) The message template to be used for the welcome message to new users.
AdminCreateUserConfigType.Builder	unusedAccountValidityDays(Integer unusedAccountValidityDays) The user account expiration limit, in days, after which a new account that hasn't signed in is no longer usable.

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

allowAdminCreateUserOnly

AdminCreateUserConfigType.Builder allowAdminCreateUserOnly(Boolean 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.

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:

Returns a reference to this object so that method calls can be chained together.

unusedAccountValidityDays

AdminCreateUserConfigType.Builder unusedAccountValidityDays(Integer 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.

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:

Returns a reference to this object so that method calls can be chained together.

inviteMessageTemplate

AdminCreateUserConfigType.Builder inviteMessageTemplate(MessageTemplateType inviteMessageTemplate)

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

Parameters:

inviteMessageTemplate - The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

Returns:

Returns a reference to this object so that method calls can be chained together.

inviteMessageTemplate

default AdminCreateUserConfigType.Builder inviteMessageTemplate(Consumer<MessageTemplateType.Builder> inviteMessageTemplate)

The message template to be used for the welcome message to new users.

See also Customizing User Invitation Messages.

This is a convenience method that creates an instance of the MessageTemplateType.Builder avoiding the need to create one manually via MessageTemplateType.builder().

When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to inviteMessageTemplate(MessageTemplateType).

Parameters:

inviteMessageTemplate - a consumer that will call methods on MessageTemplateType.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

inviteMessageTemplate(MessageTemplateType)