AdminCreateUserConfigType (AWS SDK for Java

java.lang.Object
- com.amazonaws.services.cognitoidp.model.AdminCreateUserConfigType

All Implemented Interfaces:: StructuredPojo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class AdminCreateUserConfigType
extends Object
implements Serializable, Cloneable, StructuredPojo

The configuration for creating a new user profile.

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminCreateUserConfigType()

Constructors
Constructor and Description
`AdminCreateUserConfigType()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`AdminCreateUserConfigType`	`clone()`
`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 a new account that hasn't signed in is no longer usable.
`int`	`hashCode()`
`Boolean`	`isAllowAdminCreateUserOnly()` Set to `True` if only the administrator is allowed to create user profiles.
`void`	`marshall(ProtocolMarshaller protocolMarshaller)` Marshalls this structured data using the given `ProtocolMarshaller`.
`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 a new account that hasn't signed in is no longer usable.
`String`	`toString()` Returns a string representation of this object.
`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 a new account that hasn't signed in is no longer usable.

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - AdminCreateUserConfigType
```
public AdminCreateUserConfigType()
```
- Method Detail
  - 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.
  - 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.
  - 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.
    
    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.
  - 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.
  - setUnusedAccountValidityDays
```
public void setUnusedAccountValidityDays(Integer 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 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 no longer be an available parameter for that user pool.
    
    Parameters:
    
    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 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 no longer be an available parameter for that user pool.
  - getUnusedAccountValidityDays
```
public Integer getUnusedAccountValidityDays()
```
    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 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 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 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 no longer be an available parameter for that user pool.
  - withUnusedAccountValidityDays
```
public AdminCreateUserConfigType withUnusedAccountValidityDays(Integer 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 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 no longer be an available parameter for that user pool.
    
    Parameters:
    
    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 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 no longer be an available parameter for that user pool.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - 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.
  - 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.
  - 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.
    
    Parameters:
    
    inviteMessageTemplate - The message template to be used for the welcome message to new users.
    
    See also Customizing User Invitation Messages.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - toString
```
public 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
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public AdminCreateUserConfigType clone()
```
    Overrides:
    
    clone in class Object
  - 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.

AWS SDK for Java 1.x API Reference - 1.12.793

Class AdminCreateUserConfigType

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdminCreateUserConfigType

Method Detail

setAllowAdminCreateUserOnly

getAllowAdminCreateUserOnly

withAllowAdminCreateUserOnly

isAllowAdminCreateUserOnly

setUnusedAccountValidityDays

getUnusedAccountValidityDays

withUnusedAccountValidityDays

setInviteMessageTemplate

getInviteMessageTemplate

withInviteMessageTemplate

toString

equals

hashCode

clone

marshall