Package software.amazon.awssdk.services.cognitoidentityprovider.model

Class SetUserPoolMfaConfigRequest

java.lang.Object

software.amazon.awssdk.core.SdkRequest

software.amazon.awssdk.awscore.AwsRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderRequest

software.amazon.awssdk.services.cognitoidentityprovider.model.SetUserPoolMfaConfigRequest

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

@Generated("software.amazon.awssdk:codegen")
public final class SetUserPoolMfaConfigRequest
extends CognitoIdentityProviderRequest
implements ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SetUserPoolMfaConfigRequest.Builder

Method Summary

Modifier and Type	Method	Description
static SetUserPoolMfaConfigRequest.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
UserPoolMfaType	mfaConfiguration()	The MFA configuration.
String	mfaConfigurationAsString()	The MFA configuration.
List<SdkField<?>>	sdkFields()
static Class<? extends SetUserPoolMfaConfigRequest.Builder>	serializableBuilderClass()
SmsMfaConfigType	smsMfaConfiguration()	The SMS text message MFA configuration.
SoftwareTokenMfaConfigType	softwareTokenMfaConfiguration()	The software token MFA configuration.
SetUserPoolMfaConfigRequest.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
String	userPoolId()	The user pool ID.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

overrideConfiguration

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

copy

Method Detail

userPoolId

public final String userPoolId()

The user pool ID.

Returns:

The user pool ID.

smsMfaConfiguration

public final SmsMfaConfigType smsMfaConfiguration()

The SMS text message MFA configuration.

Returns:

The SMS text message MFA configuration.

softwareTokenMfaConfiguration

public final SoftwareTokenMfaConfigType softwareTokenMfaConfiguration()

The software token MFA configuration.

Returns:

The software token MFA configuration.

mfaConfiguration

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

If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().

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

mfaConfigurationAsString

public final String mfaConfigurationAsString()

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.

If the service returns an enum value that is not available in the current SDK version, mfaConfiguration will return UserPoolMfaType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from mfaConfigurationAsString().

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

toBuilder

public SetUserPoolMfaConfigRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<SetUserPoolMfaConfigRequest.Builder,SetUserPoolMfaConfigRequest>

Specified by:

toBuilder in class CognitoIdentityProviderRequest

builder

public static SetUserPoolMfaConfigRequest.Builder builder()

serializableBuilderClass

public static Class<? extends SetUserPoolMfaConfigRequest.Builder> serializableBuilderClass()

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsRequest

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsRequest

equalsBySdkFields

public final boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

toString

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

getValueForField

public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public final List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo