Class SetUserSettingsRequest

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

public class SetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable

Represents the request to set user settings.

See Also:
  • Constructor Details

    • SetUserSettingsRequest

      public SetUserSettingsRequest()
  • Method Details

    • setAccessToken

      public void setAccessToken(String accessToken)

      The access token for the set user settings request.

      Parameters:
      accessToken - The access token for the set user settings request.
    • getAccessToken

      public String getAccessToken()

      The access token for the set user settings request.

      Returns:
      The access token for the set user settings request.
    • withAccessToken

      public SetUserSettingsRequest withAccessToken(String accessToken)

      The access token for the set user settings request.

      Parameters:
      accessToken - The access token for the set user settings request.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • getMFAOptions

      public List<MFAOptionType> getMFAOptions()

      Specifies the options for MFA (e.g., email or phone number).

      Returns:
      Specifies the options for MFA (e.g., email or phone number).
    • setMFAOptions

      public void setMFAOptions(Collection<MFAOptionType> mFAOptions)

      Specifies the options for MFA (e.g., email or phone number).

      Parameters:
      mFAOptions - Specifies the options for MFA (e.g., email or phone number).
    • withMFAOptions

      public SetUserSettingsRequest withMFAOptions(MFAOptionType... mFAOptions)

      Specifies the options for MFA (e.g., email or phone number).

      NOTE: This method appends the values to the existing list (if any). Use setMFAOptions(java.util.Collection) or withMFAOptions(java.util.Collection) if you want to override the existing values.

      Parameters:
      mFAOptions - Specifies the options for MFA (e.g., email or phone number).
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • withMFAOptions

      public SetUserSettingsRequest withMFAOptions(Collection<MFAOptionType> mFAOptions)

      Specifies the options for MFA (e.g., email or phone number).

      Parameters:
      mFAOptions - Specifies the options for MFA (e.g., email or phone number).
      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; 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 SetUserSettingsRequest 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: