com.amazonaws.services.cognitoidentityprovider.model

Class SetUserPoolMfaConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidentityprovider.model.SetUserPoolMfaConfigRequest

All Implemented Interfaces:

Serializable, Cloneable

public class SetUserPoolMfaConfigRequest
extends AmazonWebServiceRequest
implements Serializable

Set the user pool multi-factor authentication (MFA) configuration.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
SetUserPoolMfaConfigRequest()

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String	getMfaConfiguration() The MFA configuration.
SmsMfaConfigType	getSmsMfaConfiguration() The SMS text message MFA configuration.
SoftwareTokenMfaConfigType	getSoftwareTokenMfaConfiguration() The software token MFA configuration.
String	getUserPoolId() The user pool ID.
int	hashCode()
void	setMfaConfiguration(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(String userPoolId) The user pool ID.
String	toString() Returns a string representation of this object; useful for testing and debugging.
SetUserPoolMfaConfigRequest	withMfaConfiguration(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(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 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(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(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 String getMfaConfiguration()

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

Returns:

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

See Also:

UserPoolMfaType

setMfaConfiguration

public void setMfaConfiguration(String mfaConfiguration)

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

Parameters:

mfaConfiguration -

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

See Also:

UserPoolMfaType

withMfaConfiguration

public SetUserPoolMfaConfigRequest withMfaConfiguration(String mfaConfiguration)

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

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. Valid values include:

• OFF MFA will not 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 enabled.

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. Valid values include:

• OFF MFA will not 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 enabled.

Constraints:
Allowed Values: OFF, ON, OPTIONAL

Parameters:

mfaConfiguration -

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

See Also:

UserPoolMfaType

withMfaConfiguration

public SetUserPoolMfaConfigRequest withMfaConfiguration(UserPoolMfaType mfaConfiguration)

The MFA configuration. Valid values include:

• OFF MFA will not 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 enabled.

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. Valid values include:

• OFF MFA will not 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 enabled.

Returns:

A reference to this updated object so that method calls can be chained together.

See Also:

UserPoolMfaType

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:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object