software.amazon.awssdk.services.cognitoidentityprovider.model

Class AdminCreateUserConfigType

java.lang.Object

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

All Implemented Interfaces:

StructuredPojo, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

@Generated(value="software.amazon.awssdk:codegen")
public class AdminCreateUserConfigType
extends Object
implements StructuredPojo, ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

The type of configuration for creating a new user profile.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	AdminCreateUserConfigType.Builder

Method Summary

Modifier and Type	Method and Description
Boolean	allowAdminCreateUserOnly() Set to True if only the administrator is allowed to create user profiles.
static AdminCreateUserConfigType.Builder	builder()
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
MessageTemplateType	inviteMessageTemplate() The message template to be used for the welcome message to new users.
void	marshall(ProtocolMarshaller protocolMarshaller) Marshalls this structured data using the given ProtocolMarshaller.
static Class<? extends AdminCreateUserConfigType.Builder>	serializableBuilderClass()
AdminCreateUserConfigType.Builder	toBuilder() Take this object and create a builder that contains all of the current property values of this object.
String	toString()
Integer	unusedAccountValidityDays() The user account expiration limit, in days, after which the account is no longer usable.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

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

copy

Method Detail

allowAdminCreateUserOnly

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

Returns:

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.

unusedAccountValidityDays

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

Returns:

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.

inviteMessageTemplate

public MessageTemplateType inviteMessageTemplate()

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

Returns:

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

toBuilder

public AdminCreateUserConfigType.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<AdminCreateUserConfigType.Builder,AdminCreateUserConfigType>

Returns:

a builder for type T

builder

public static AdminCreateUserConfigType.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

getValueForField

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

marshall

public void marshall(ProtocolMarshaller protocolMarshaller)

Description copied from interface: StructuredPojo

Marshalls this structured data using the given ProtocolMarshaller.

Specified by:

marshall in interface StructuredPojo

Parameters:

protocolMarshaller - Implementation of ProtocolMarshaller used to marshall this object's data.