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

Interface AdminCreateUserConfigType.Builder

All Superinterfaces:

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

Enclosing class:

AdminCreateUserConfigType

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

Method Summary

Modifier and Type	Method	Description
AdminCreateUserConfigType.Builder	allowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly)	Set to True if only the administrator is allowed to create user profiles.
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 the account is no longer usable.

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

copy

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

apply, 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 the account 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.

Parameters:

unusedAccountValidityDays - The user account expiration limit, in days, after which the account 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.

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.

Parameters:

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

Returns:

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