Class AdminCreateUserConfigType
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<AdminCreateUserConfigType.Builder,
AdminCreateUserConfigType>
The configuration for creating a new user profile.
- See Also:
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Set toTrue
if only the administrator is allowed to create user profiles.builder()
final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) final int
hashCode()
final MessageTemplateType
The message template to be used for the welcome message to new users.static Class
<? extends AdminCreateUserConfigType.Builder> Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.final Integer
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.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
allowAdminCreateUserOnly
Set to
True
if only the administrator is allowed to create user profiles. Set toFalse
if users can sign themselves up via an app.- Returns:
- Set to
True
if only the administrator is allowed to create user profiles. Set toFalse
if users can sign themselves up via an app.
-
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 theMessageAction
parameter. The default value for this parameter is 7.If you set a value for
TemporaryPasswordValidityDays
inPasswordPolicy
, that value will be used, andUnusedAccountValidityDays
will be no longer be an available parameter for that user pool.- Returns:
- 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 theMessageAction
parameter. The default value for this parameter is 7.If you set a value for
TemporaryPasswordValidityDays
inPasswordPolicy
, that value will be used, andUnusedAccountValidityDays
will be no longer be an available parameter for that user pool.
-
inviteMessageTemplate
The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
- Returns:
- The message template to be used for the welcome message to new users.
See also Customizing User Invitation Messages.
-
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 interfaceToCopyableBuilder<AdminCreateUserConfigType.Builder,
AdminCreateUserConfigType> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode() -
equals
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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. -
getValueForField
-
sdkFields
-