Class ConfirmSignUpRequest

java.lang.Object
com.amazonaws.AmazonWebServiceRequest
com.amazonaws.services.cognitoidp.model.ConfirmSignUpRequest
All Implemented Interfaces:
ReadLimitInfo, Serializable, Cloneable

public class ConfirmSignUpRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the request to confirm registration of a user.

See Also:
  • Constructor Details

    • ConfirmSignUpRequest

      public ConfirmSignUpRequest()
  • Method Details

    • setClientId

      public void setClientId(String clientId)

      The ID of the client associated with the user pool.

      Parameters:
      clientId - The ID of the client associated with the user pool.
    • getClientId

      public String getClientId()

      The ID of the client associated with the user pool.

      Returns:
      The ID of the client associated with the user pool.
    • withClientId

      public ConfirmSignUpRequest withClientId(String clientId)

      The ID of the client associated with the user pool.

      Parameters:
      clientId - The ID of the client associated with the user pool.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setSecretHash

      public void setSecretHash(String secretHash)

      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

      Parameters:
      secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    • getSecretHash

      public String getSecretHash()

      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

      Returns:
      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
    • withSecretHash

      public ConfirmSignUpRequest withSecretHash(String secretHash)

      A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.

      Parameters:
      secretHash - A keyed-hash message authentication code (HMAC) calculated using the secret key of a user pool client and username plus the client ID in the message.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setUsername

      public void setUsername(String username)

      The user name of the user whose registration you wish to confirm.

      Parameters:
      username - The user name of the user whose registration you wish to confirm.
    • getUsername

      public String getUsername()

      The user name of the user whose registration you wish to confirm.

      Returns:
      The user name of the user whose registration you wish to confirm.
    • withUsername

      public ConfirmSignUpRequest withUsername(String username)

      The user name of the user whose registration you wish to confirm.

      Parameters:
      username - The user name of the user whose registration you wish to confirm.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setConfirmationCode

      public void setConfirmationCode(String confirmationCode)

      The confirmation code sent by a user's request to confirm registration.

      Parameters:
      confirmationCode - The confirmation code sent by a user's request to confirm registration.
    • getConfirmationCode

      public String getConfirmationCode()

      The confirmation code sent by a user's request to confirm registration.

      Returns:
      The confirmation code sent by a user's request to confirm registration.
    • withConfirmationCode

      public ConfirmSignUpRequest withConfirmationCode(String confirmationCode)

      The confirmation code sent by a user's request to confirm registration.

      Parameters:
      confirmationCode - The confirmation code sent by a user's request to confirm registration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • setForceAliasCreation

      public void setForceAliasCreation(Boolean forceAliasCreation)

      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

      Parameters:
      forceAliasCreation - Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
    • getForceAliasCreation

      public Boolean getForceAliasCreation()

      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

      Returns:
      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
    • withForceAliasCreation

      public ConfirmSignUpRequest withForceAliasCreation(Boolean forceAliasCreation)

      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

      Parameters:
      forceAliasCreation - Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • isForceAliasCreation

      public Boolean isForceAliasCreation()

      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.

      Returns:
      Boolean to be specified to force user confirmation irrespective of existing alias. By default set to False. If this parameter is set to True and the phone number/email used for sign up confirmation already exists as an alias with a different user, the API call will migrate the alias from the previous user to the newly created user being confirmed. If set to False, the API will throw an AliasExistsException error.
    • 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:
    • equals

      public boolean equals(Object obj)
      Overrides:
      equals in class Object
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • clone

      public ConfirmSignUpRequest clone()
      Description copied from class: AmazonWebServiceRequest
      Creates a shallow clone of this request. Explicitly does not clone the deep structure of the request object.
      Overrides:
      clone in class AmazonWebServiceRequest
      See Also: