Class AdminSetUserSettingsRequest
- java.lang.Object
-
- com.amazonaws.AmazonWebServiceRequest
-
- com.amazonaws.services.cognitoidp.model.AdminSetUserSettingsRequest
-
- All Implemented Interfaces:
ReadLimitInfo
,Serializable
,Cloneable
public class AdminSetUserSettingsRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
Represents the request to set user settings as an administrator.
- See Also:
- Serialized Form
-
-
Field Summary
-
Fields inherited from class com.amazonaws.AmazonWebServiceRequest
NOOP
-
-
Constructor Summary
Constructors Constructor Description AdminSetUserSettingsRequest()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AdminSetUserSettingsRequest
clone()
Creates a shallow clone of this request.boolean
equals(Object obj)
List<MFAOptionType>
getMFAOptions()
Specifies the options for MFA (e.g., email or phone number).String
getUsername()
The user name of the user for whom you wish to set user settings.String
getUserPoolId()
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.int
hashCode()
void
setMFAOptions(Collection<MFAOptionType> mFAOptions)
Specifies the options for MFA (e.g., email or phone number).void
setUsername(String username)
The user name of the user for whom you wish to set user settings.void
setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.String
toString()
Returns a string representation of this object; useful for testing and debugging.AdminSetUserSettingsRequest
withMFAOptions(MFAOptionType... mFAOptions)
Specifies the options for MFA (e.g., email or phone number).AdminSetUserSettingsRequest
withMFAOptions(Collection<MFAOptionType> mFAOptions)
Specifies the options for MFA (e.g., email or phone number).AdminSetUserSettingsRequest
withUsername(String username)
The user name of the user for whom you wish to set user settings.AdminSetUserSettingsRequest
withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.-
Methods inherited from class com.amazonaws.AmazonWebServiceRequest
copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
-
-
-
-
Method Detail
-
setUserPoolId
public void setUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
-
getUserPoolId
public String getUserPoolId()
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Returns:
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
-
withUserPoolId
public AdminSetUserSettingsRequest withUserPoolId(String userPoolId)
The user pool ID for the user pool where you want to set the user's settings, such as MFA options.
- Parameters:
userPoolId
- The user pool ID for the user pool where you want to set the user's settings, such as MFA options.- 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 for whom you wish to set user settings.
- Parameters:
username
- The user name of the user for whom you wish to set user settings.
-
getUsername
public String getUsername()
The user name of the user for whom you wish to set user settings.
- Returns:
- The user name of the user for whom you wish to set user settings.
-
withUsername
public AdminSetUserSettingsRequest withUsername(String username)
The user name of the user for whom you wish to set user settings.
- Parameters:
username
- The user name of the user for whom you wish to set user settings.- 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 AdminSetUserSettingsRequest 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)
orwithMFAOptions(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 AdminSetUserSettingsRequest 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 classObject
- Returns:
- A string representation of this object.
- See Also:
Object.toString()
-
clone
public AdminSetUserSettingsRequest 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 classAmazonWebServiceRequest
- See Also:
Object.clone()
-
-