AdminSetUserMFAPreferenceRequest (aws-android-sdk-cognitoidentityprovider 2.81.1 API)

java.lang.Object
- com.amazonaws.AmazonWebServiceRequest
- - com.amazonaws.services.cognitoidentityprovider.model.AdminSetUserMFAPreferenceRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class AdminSetUserMFAPreferenceRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
The user's multi-factor authentication (MFA) preference, including which MFA options are activated, and if any are preferred. Only one factor can be set as preferred. The preferred MFA factor will be used to authenticate a user if multiple factors are activated. If multiple options are activated and no preference is set, a challenge to choose an MFA option will be returned during sign-in.
Amazon Cognito evaluates Identity and Access Management (IAM) policies in requests for this API operation. For this operation, you must use IAM credentials to authorize requests, and you must grant yourself the corresponding IAM permission in a policy.

Learn more
- Signing Amazon Web Services API Requests
- Using the Amazon Cognito user pools API and user pool endpoints
See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

AdminSetUserMFAPreferenceRequest()

Constructors
Constructor and Description
`AdminSetUserMFAPreferenceRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`SMSMfaSettingsType`	`getSMSMfaSettings()` The SMS text message MFA settings.
`SoftwareTokenMfaSettingsType`	`getSoftwareTokenMfaSettings()` The time-based one-time password software token MFA settings.
`java.lang.String`	`getUsername()` The user pool username or alias.
`java.lang.String`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`void`	`setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)` The SMS text message MFA settings.
`void`	`setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)` The time-based one-time password software token MFA settings.
`void`	`setUsername(java.lang.String username)` The user pool username or alias.
`void`	`setUserPoolId(java.lang.String userPoolId)` The user pool ID.
`java.lang.String`	`toString()` Returns a string representation of this object; useful for testing and debugging.
`AdminSetUserMFAPreferenceRequest`	`withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)` The SMS text message MFA settings.
`AdminSetUserMFAPreferenceRequest`	`withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)` The time-based one-time password software token MFA settings.
`AdminSetUserMFAPreferenceRequest`	`withUsername(java.lang.String username)` The user pool username or alias.
`AdminSetUserMFAPreferenceRequest`	`withUserPoolId(java.lang.String userPoolId)` The user pool ID.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest
clone, copyBaseTo, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

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

- Constructor Detail
  - AdminSetUserMFAPreferenceRequest
```
public AdminSetUserMFAPreferenceRequest()
```
- Method Detail
  - getSMSMfaSettings
```
public SMSMfaSettingsType getSMSMfaSettings()
```
    The SMS text message MFA settings.
    
    Returns:
    
    The SMS text message MFA settings.
  - setSMSMfaSettings
```
public void setSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)
```
    The SMS text message MFA settings.
    
    Parameters:
    
    sMSMfaSettings -
    The SMS text message MFA settings.
  - withSMSMfaSettings
```
public AdminSetUserMFAPreferenceRequest withSMSMfaSettings(SMSMfaSettingsType sMSMfaSettings)
```
    The SMS text message MFA settings.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    sMSMfaSettings -
    The SMS text message MFA settings.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSoftwareTokenMfaSettings
```
public SoftwareTokenMfaSettingsType getSoftwareTokenMfaSettings()
```
    The time-based one-time password software token MFA settings.
    
    Returns:
    
    The time-based one-time password software token MFA settings.
  - setSoftwareTokenMfaSettings
```
public void setSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)
```
    The time-based one-time password software token MFA settings.
    
    Parameters:
    
    softwareTokenMfaSettings -
    The time-based one-time password software token MFA settings.
  - withSoftwareTokenMfaSettings
```
public AdminSetUserMFAPreferenceRequest withSoftwareTokenMfaSettings(SoftwareTokenMfaSettingsType softwareTokenMfaSettings)
```
    The time-based one-time password software token MFA settings.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    softwareTokenMfaSettings -
    The time-based one-time password software token MFA settings.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUsername
```
public java.lang.String getUsername()
```
    The user pool username or alias.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Returns:
    
    The user pool username or alias.
  - setUsername
```
public void setUsername(java.lang.String username)
```
    The user pool username or alias.
    
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user pool username or alias.
  - withUsername
```
public AdminSetUserMFAPreferenceRequest withUsername(java.lang.String username)
```
    The user pool username or alias.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 128
    Pattern: [\p{L}\p{M}\p{S}\p{N}\p{P}]+
    
    Parameters:
    
    username -
    The user pool username or alias.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getUserPoolId
```
public java.lang.String getUserPoolId()
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Returns:
    
    The user pool ID.
  - setUserPoolId
```
public void setUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
  - withUserPoolId
```
public AdminSetUserMFAPreferenceRequest withUserPoolId(java.lang.String userPoolId)
```
    The user pool ID.
    
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Length: 1 - 55
    Pattern: [\w-]+_[0-9a-zA-Z]+
    
    Parameters:
    
    userPoolId -
    The user pool ID.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - toString
```
public java.lang.String toString()
```
    Returns a string representation of this object; useful for testing and debugging.
    
    Overrides:
    
    toString in class java.lang.Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class java.lang.Object
  - equals
```
public boolean equals(java.lang.Object obj)
```
    Overrides:
    
    equals in class java.lang.Object

Class AdminSetUserMFAPreferenceRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

AdminSetUserMFAPreferenceRequest

Method Detail

getSMSMfaSettings

setSMSMfaSettings

withSMSMfaSettings

getSoftwareTokenMfaSettings

setSoftwareTokenMfaSettings

withSoftwareTokenMfaSettings

getUsername

setUsername

withUsername

getUserPoolId

setUserPoolId

withUserPoolId

toString

hashCode

equals