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

Class AdminCreateUserConfigType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.AdminCreateUserConfigType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

@Generated("software.amazon.awssdk:codegen")
public final class AdminCreateUserConfigType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

The settings for administrator creation of users in a user pool. Contains settings for allowing user sign-up, customizing invitation messages to new users, and the amount of time before temporary passwords expire.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	AdminCreateUserConfigType.Builder

Method Summary

Modifier and Type	Method	Description
Boolean	allowAdminCreateUserOnly()	The setting for allowing self-service sign-up.
static AdminCreateUserConfigType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageTemplateType	inviteMessageTemplate()	The template for the welcome message to new users.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends AdminCreateUserConfigType.Builder>	serializableBuilderClass()
AdminCreateUserConfigType.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	unusedAccountValidityDays()	This parameter is no longer in use.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

allowAdminCreateUserOnly

public final 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.

Returns:

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.

unusedAccountValidityDays

public final Integer 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 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.

inviteMessageTemplate

public final 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.

Returns:

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.

toBuilder

public AdminCreateUserConfigType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

builder

public static AdminCreateUserConfigType.Builder builder()

serializableBuilderClass

public static Class<? extends AdminCreateUserConfigType.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

public final String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo