Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AdminCreateUserConfigType.Builder

All Superinterfaces:

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

Enclosing class:

AdminCreateUserConfigType

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

Method Summary

Modifier and Type	Method	Description
AdminCreateUserConfigType.Builder	allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly)	The setting for allowing self-service sign-up.
default AdminCreateUserConfigType.Builder	inviteMessageTemplate(Consumer<MessageTemplateType.Builder> inviteMessageTemplate)	The template for the welcome message to new users.
AdminCreateUserConfigType.Builder	inviteMessageTemplate(MessageTemplateType inviteMessageTemplate)	The template for the welcome message to new users.
AdminCreateUserConfigType.Builder	unusedAccountValidityDays(Integer unusedAccountValidityDays)	This parameter is no longer in use.

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

copy

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Detail

allowAdminCreateUserOnly

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

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:

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

unusedAccountValidityDays

AdminCreateUserConfigType.Builder unusedAccountValidityDays(Integer 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 call AdminCreateUser again, specifying RESEND for the MessageAction parameter.

The default value for this parameter is 7.

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 call AdminCreateUser again, specifying RESEND for the MessageAction parameter.

The default value for this parameter is 7.

Returns:

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

inviteMessageTemplate

AdminCreateUserConfigType.Builder inviteMessageTemplate(MessageTemplateType 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.

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:

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

inviteMessageTemplate

default AdminCreateUserConfigType.Builder inviteMessageTemplate(Consumer<MessageTemplateType.Builder> 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.

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)