com.amazonaws.services.cognitoidp.model

Class SetUserPoolMfaConfigRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.cognitoidp.model.SetUserPoolMfaConfigRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class SetUserPoolMfaConfigRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
SetUserPoolMfaConfigRequest()

Method Summary

Modifier and Type	Method and Description
SetUserPoolMfaConfigRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
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	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.
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

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

SetUserPoolMfaConfigRequest

public SetUserPoolMfaConfigRequest()

Method Detail

setUserPoolId

public void setUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

getUserPoolId

public String getUserPoolId()

The user pool ID.

Returns:

The user pool ID.

withUserPoolId

public SetUserPoolMfaConfigRequest withUserPoolId(String userPoolId)

The user pool ID.

Parameters:

userPoolId - The user pool ID.

Returns:

Returns a reference to this object so that method calls can be chained together.

setSmsMfaConfiguration

public void setSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)

The SMS text message MFA configuration.

Parameters:

smsMfaConfiguration - The SMS text message MFA configuration.

getSmsMfaConfiguration

public SmsMfaConfigType getSmsMfaConfiguration()

The SMS text message MFA configuration.

Returns:

The SMS text message MFA configuration.

withSmsMfaConfiguration

public SetUserPoolMfaConfigRequest withSmsMfaConfiguration(SmsMfaConfigType smsMfaConfiguration)

The SMS text message MFA configuration.

Parameters:

smsMfaConfiguration - The SMS text message 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 MFA configuration.

Parameters:

softwareTokenMfaConfiguration - The software token MFA configuration.

getSoftwareTokenMfaConfiguration

public SoftwareTokenMfaConfigType getSoftwareTokenMfaConfiguration()

The software token MFA configuration.

Returns:

The software token MFA configuration.

withSoftwareTokenMfaConfiguration

public SetUserPoolMfaConfigRequest withSoftwareTokenMfaConfiguration(SoftwareTokenMfaConfigType softwareTokenMfaConfiguration)

The software token MFA configuration.

Parameters:

softwareTokenMfaConfiguration - The software token MFA configuration.

Returns:

Returns a reference to this object so that method calls can be chained together.

setMfaConfiguration

public void setMfaConfiguration(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.

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

getMfaConfiguration

public 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.

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

withMfaConfiguration

public SetUserPoolMfaConfigRequest withMfaConfiguration(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.

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:

Returns a reference to this object so that method calls can be chained together.

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.

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:

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 SetUserPoolMfaConfigRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()