GetUserPoolMfaConfigResult (AWS SDK for Java

java.lang.Object
- com.amazonaws.AmazonWebServiceResult<ResponseMetadata>
- - com.amazonaws.services.cognitoidp.model.GetUserPoolMfaConfigResult

All Implemented Interfaces:: Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class GetUserPoolMfaConfigResult
extends AmazonWebServiceResult<ResponseMetadata>
implements Serializable, Cloneable

See Also:: AWS API Documentation, Serialized Form

Constructor Summary

Constructors
Constructor and Description

GetUserPoolMfaConfigResult()

Constructors
Constructor and Description
`GetUserPoolMfaConfigResult()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`GetUserPoolMfaConfigResult`	`clone()`
`boolean`	`equals(Object obj)`
`String`	`getMfaConfiguration()` The multi-factor (MFA) configuration.
`SmsMfaConfigType`	`getSmsMfaConfiguration()` The SMS text message multi-factor (MFA) configuration.
`SoftwareTokenMfaConfigType`	`getSoftwareTokenMfaConfiguration()` The software token multi-factor (MFA) configuration.
`int`	`hashCode()`
`void`	`setMfaConfiguration(String mfaConfiguration)` The multi-factor (MFA) configuration.
`void`	`setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)` The SMS text message multi-factor (MFA) configuration.
`void`	`setSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)` The software token multi-factor (MFA) configuration.
`String`	`toString()` Returns a string representation of this object.
`GetUserPoolMfaConfigResult`	`withMfaConfiguration(String mfaConfiguration)` The multi-factor (MFA) configuration.
`GetUserPoolMfaConfigResult`	`withMfaConfiguration(UserPoolMfaType mfaConfiguration)` The multi-factor (MFA) configuration.
`GetUserPoolMfaConfigResult`	`withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)` The SMS text message multi-factor (MFA) configuration.
`GetUserPoolMfaConfigResult`	`withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)` The software token multi-factor (MFA) configuration.

Methods inherited from class com.amazonaws.AmazonWebServiceResult
getSdkHttpMetadata, getSdkResponseMetadata, setSdkHttpMetadata, setSdkResponseMetadata

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

- Constructor Detail
  - GetUserPoolMfaConfigResult
```
public GetUserPoolMfaConfigResult()
```
- Method Detail
  - setSmsMfaConfiguration
```
public void setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)
```
    The SMS text message multi-factor (MFA) configuration.
    
    Parameters:
    
    smsMfaConfiguration - The SMS text message multi-factor (MFA) configuration.
  - getSmsMfaConfiguration
```
public SmsMfaConfigType getSmsMfaConfiguration()
```
    The SMS text message multi-factor (MFA) configuration.
    
    Returns:
    
    The SMS text message multi-factor (MFA) configuration.
  - withSmsMfaConfiguration
```
public GetUserPoolMfaConfigResult withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)
```
    The SMS text message multi-factor (MFA) configuration.
    
    Parameters:
    
    smsMfaConfiguration - The SMS text message multi-factor (MFA) configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setSoftwareTokenMfaConfiguration
```
public void setSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)
```
    The software token multi-factor (MFA) configuration.
    
    Parameters:
    
    softwareTokenMfaConfiguration - The software token multi-factor (MFA) configuration.
  - getSoftwareTokenMfaConfiguration
```
public SoftwareTokenMfaConfigType getSoftwareTokenMfaConfiguration()
```
    The software token multi-factor (MFA) configuration.
    
    Returns:
    
    The software token multi-factor (MFA) configuration.
  - withSoftwareTokenMfaConfiguration
```
public GetUserPoolMfaConfigResult withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)
```
    The software token multi-factor (MFA) configuration.
    
    Parameters:
    
    softwareTokenMfaConfiguration - The software token multi-factor (MFA) configuration.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - setMfaConfiguration
```
public void setMfaConfiguration(String mfaConfiguration)
```
    The multi-factor (MFA) configuration. 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.
    Parameters:
    mfaConfiguration - The multi-factor (MFA) configuration. 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
  - getMfaConfiguration
```
public String getMfaConfiguration()
```
    The multi-factor (MFA) configuration. 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:
    The multi-factor (MFA) configuration. 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 GetUserPoolMfaConfigResult withMfaConfiguration(String mfaConfiguration)
```
    The multi-factor (MFA) configuration. 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.
    Parameters:
    mfaConfiguration - The multi-factor (MFA) configuration. 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - withMfaConfiguration
```
public GetUserPoolMfaConfigResult withMfaConfiguration(UserPoolMfaType mfaConfiguration)
```
    The multi-factor (MFA) configuration. 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.
    Parameters:
    mfaConfiguration - The multi-factor (MFA) configuration. 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:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    UserPoolMfaType
  - toString
```
public String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    A string representation of this object.
    
    See Also:
    
    Object.toString()
  - equals
```
public boolean equals(Object obj)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public int hashCode()
```
    Overrides:
    
    hashCode in class Object
  - clone
```
public GetUserPoolMfaConfigResult clone()
```
    Overrides:
    
    clone in class Object

Did this page help you?

Class GetUserPoolMfaConfigResult

Constructor Summary

Method Summary

Methods inherited from class com.amazonaws.AmazonWebServiceResult

Methods inherited from class java.lang.Object

Constructor Detail

GetUserPoolMfaConfigResult

Method Detail

setSmsMfaConfiguration

getSmsMfaConfiguration

withSmsMfaConfiguration

setSoftwareTokenMfaConfiguration

getSoftwareTokenMfaConfiguration

withSoftwareTokenMfaConfiguration

setMfaConfiguration

getMfaConfiguration

withMfaConfiguration

withMfaConfiguration

toString

equals

hashCode

clone