com.amazonaws.services.cognitoidentityprovider.model

Class AdminCreateUserConfigType

java.lang.Object

com.amazonaws.services.cognitoidentityprovider.model.AdminCreateUserConfigType

All Implemented Interfaces:

Serializable

public class AdminCreateUserConfigType
extends Object
implements Serializable

The configuration for creating a new user profile.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AdminCreateUserConfigType()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Boolean	getAllowAdminCreateUserOnly() Set to True if only the administrator is allowed to create user profiles.
MessageTemplateType	getInviteMessageTemplate() The message template to be used for the welcome message to new users.
Integer	getUnusedAccountValidityDays() The user account expiration limit, in days, after which the account is no longer usable.
int	hashCode()
Boolean	isAllowAdminCreateUserOnly() Set to True if only the administrator is allowed to create user profiles.
void	setAllowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) Set to True if only the administrator is allowed to create user profiles.
void	setInviteMessageTemplate(MessageTemplateType inviteMessageTemplate) The message template to be used for the welcome message to new users.
void	setUnusedAccountValidityDays(Integer unusedAccountValidityDays) The user account expiration limit, in days, after which the account is no longer usable.
String	toString() Returns a string representation of this object; useful for testing and debugging.
AdminCreateUserConfigType	withAllowAdminCreateUserOnly(Boolean allowAdminCreateUserOnly) Set to True if only the administrator is allowed to create user profiles.
AdminCreateUserConfigType	withInviteMessageTemplate(MessageTemplateType inviteMessageTemplate) The message template to be used for the welcome message to new users.
AdminCreateUserConfigType	withUnusedAccountValidityDays(Integer unusedAccountValidityDays) The user account expiration limit, in days, after which the account is no longer usable.

Methods inherited from class java.lang.Object

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

Constructor Detail

AdminCreateUserConfigType

public AdminCreateUserConfigType()

Method Detail

isAllowAdminCreateUserOnly

public Boolean isAllowAdminCreateUserOnly()

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.

getAllowAdminCreateUserOnly

public Boolean getAllowAdminCreateUserOnly()

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.

setAllowAdminCreateUserOnly

public void setAllowAdminCreateUserOnly(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.

withAllowAdminCreateUserOnly

public AdminCreateUserConfigType withAllowAdminCreateUserOnly(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 a reference to this object so that method calls can be chained together.

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:

A reference to this updated object so that method calls can be chained together.

getUnusedAccountValidityDays

public Integer getUnusedAccountValidityDays()

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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

Constraints:
Range: 0 - 365

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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

setUnusedAccountValidityDays

public void setUnusedAccountValidityDays(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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

Constraints:
Range: 0 - 365

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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

withUnusedAccountValidityDays

public AdminCreateUserConfigType withUnusedAccountValidityDays(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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

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

Constraints:
Range: 0 - 365

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.

If you set a value for TemporaryPasswordValidityDays in PasswordPolicy, that value will be used and UnusedAccountValidityDays will be deprecated for that user pool.

Returns:

A reference to this updated object so that method calls can be chained together.

getInviteMessageTemplate

public MessageTemplateType getInviteMessageTemplate()

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.

setInviteMessageTemplate

public void setInviteMessageTemplate(MessageTemplateType inviteMessageTemplate)

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

See also Customizing User Invitation Messages.

Parameters:

inviteMessageTemplate -

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

See also Customizing User Invitation Messages.

withInviteMessageTemplate

public AdminCreateUserConfigType withInviteMessageTemplate(MessageTemplateType inviteMessageTemplate)

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

See also Customizing User Invitation Messages.

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

Parameters:

inviteMessageTemplate -

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

See also Customizing User Invitation Messages.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object