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

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

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable
```
public class SetUserPoolMfaConfigRequest
extends com.amazonaws.AmazonWebServiceRequest
implements java.io.Serializable
```
Sets the user pool multi-factor authentication (MFA) configuration.

This action might generate an SMS text message. Starting June 1, 2021, US telecom carriers require you to register an origination phone number before you can send SMS messages to US phone numbers. If you use SMS text messages in Amazon Cognito, you must register a phone number with Amazon Pinpoint. Amazon Cognito uses the registered number automatically. Otherwise, Amazon Cognito users who must receive SMS messages might not be able to sign up, activate their accounts, or sign in.

If you have never used SMS text messages with Amazon Cognito or any other Amazon Web Service, Amazon Simple Notification Service might place your account in the SMS sandbox. In sandbox mode , you can send messages only to verified phone numbers. After you test your app while in the sandbox environment, you can move out of the sandbox and into production. For more information, see SMS message settings for Amazon Cognito user pools in the Amazon Cognito Developer Guide.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SetUserPoolMfaConfigRequest()

Constructors
Constructor and Description
`SetUserPoolMfaConfigRequest()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`boolean`	`equals(java.lang.Object obj)`
`java.lang.String`	`getMfaConfiguration()` The MFA configuration.
`SmsMfaConfigType`	`getSmsMfaConfiguration()` The SMS text message MFA configuration.
`SoftwareTokenMfaConfigType`	`getSoftwareTokenMfaConfiguration()` The software token MFA configuration.
`java.lang.String`	`getUserPoolId()` The user pool ID.
`int`	`hashCode()`
`void`	`setMfaConfiguration(java.lang.String mfaConfiguration)` The MFA configuration.
`void`	`setMfaConfiguration(UserPoolMfaType mfaConfiguration)` The MFA configuration.
`void`	`setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)` The SMS text message MFA configuration.
`void`	`setSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)` The software token MFA configuration.
`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.
`SetUserPoolMfaConfigRequest`	`withMfaConfiguration(java.lang.String mfaConfiguration)` The MFA configuration.
`SetUserPoolMfaConfigRequest`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` The MFA configuration.
`SetUserPoolMfaConfigRequest`	`withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)` The SMS text message MFA configuration.
`SetUserPoolMfaConfigRequest`	`withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)` The software token MFA configuration.
`SetUserPoolMfaConfigRequest`	`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
  - SetUserPoolMfaConfigRequest
```
public SetUserPoolMfaConfigRequest()
```
- Method Detail
  - 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 SetUserPoolMfaConfigRequest 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.
  - getSmsMfaConfiguration
```
public SmsMfaConfigType getSmsMfaConfiguration()
```
    The SMS text message MFA configuration.
    
    Returns:
    
    The SMS text message MFA configuration.
  - setSmsMfaConfiguration
```
public void setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)
```
    The SMS text message MFA configuration.
    
    Parameters:
    
    smsMfaConfiguration -
    The SMS text message MFA configuration.
  - withSmsMfaConfiguration
```
public SetUserPoolMfaConfigRequest withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)
```
    The SMS text message MFA configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    smsMfaConfiguration -
    The SMS text message MFA configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getSoftwareTokenMfaConfiguration
```
public SoftwareTokenMfaConfigType getSoftwareTokenMfaConfiguration()
```
    The software token MFA configuration.
    
    Returns:
    
    The software token MFA configuration.
  - setSoftwareTokenMfaConfiguration
```
public void setSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)
```
    The software token MFA configuration.
    
    Parameters:
    
    softwareTokenMfaConfiguration -
    The software token MFA configuration.
  - withSoftwareTokenMfaConfiguration
```
public SetUserPoolMfaConfigRequest withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)
```
    The software token MFA configuration.
    
    Returns a reference to this object so that method calls can be chained together.
    
    Parameters:
    
    softwareTokenMfaConfiguration -
    The software token MFA configuration.
    
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
  - getMfaConfiguration
```
public java.lang.String getMfaConfiguration()
```
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    - OFF MFA won't be used for any users.
    - ON MFA is required for all users to sign in.
    - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Returns:
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    
    OFF MFA won't be used for any users.
    
    ON MFA is required for all users to sign in.
    
    OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(java.lang.String mfaConfiguration)
```
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    - OFF MFA won't be used for any users.
    - ON MFA is required for all users to sign in.
    - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    mfaConfiguration -
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    
    OFF MFA won't be used for any users.
    
    ON MFA is required for all users to sign in.
    
    OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public SetUserPoolMfaConfigRequest withMfaConfiguration(java.lang.String mfaConfiguration)
```
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    - OFF MFA won't be used for any users.
    - ON MFA is required for all users to sign in.
    - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    mfaConfiguration -
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    
    OFF MFA won't be used for any users.
    
    ON MFA is required for all users to sign in.
    
    OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - setMfaConfiguration
```
public void setMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    - OFF MFA won't be used for any users.
    - ON MFA is required for all users to sign in.
    - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    mfaConfiguration -
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    
    OFF MFA won't be used for any users.
    
    ON MFA is required for all users to sign in.
    
    OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public SetUserPoolMfaConfigRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    - OFF MFA won't be used for any users.
    - ON MFA is required for all users to sign in.
    - OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Returns a reference to this object so that method calls can be chained together.
    Constraints:
    Allowed Values: OFF, ON, OPTIONAL
    Parameters:
    mfaConfiguration -
    The MFA configuration. If you set the MfaConfiguration value to ‘ON’, only users who have set up an MFA factor can sign in. To learn more, see Adding Multi-Factor Authentication (MFA) to a user pool. Valid values include:
    
    OFF MFA won't be used for any users.
    
    ON MFA is required for all users to sign in.
    
    OPTIONAL MFA will be required only for individual users who have an MFA factor activated.
    Returns:
    
    A reference to this updated object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - 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 SetUserPoolMfaConfigRequest

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

Methods inherited from class java.lang.Object

Constructor Detail

SetUserPoolMfaConfigRequest

Method Detail

getUserPoolId

setUserPoolId

withUserPoolId

getSmsMfaConfiguration

setSmsMfaConfiguration

withSmsMfaConfiguration

getSoftwareTokenMfaConfiguration

setSoftwareTokenMfaConfiguration

withSoftwareTokenMfaConfiguration

getMfaConfiguration

setMfaConfiguration

withMfaConfiguration

setMfaConfiguration

withMfaConfiguration

toString

hashCode

equals