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

Class GetUserPoolMfaConfigResponse

java.lang.Object

software.amazon.awssdk.core.SdkResponse

software.amazon.awssdk.awscore.AwsResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

software.amazon.awssdk.services.cognitoidentityprovider.model.GetUserPoolMfaConfigResponse

All Implemented Interfaces:

SdkPojo, ToCopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	GetUserPoolMfaConfigResponse.Builder

Method Summary

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

Methods inherited from class software.amazon.awssdk.services.cognitoidentityprovider.model.CognitoIdentityProviderResponse

responseMetadata

Methods inherited from class software.amazon.awssdk.core.SdkResponse

sdkHttpResponse

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

smsMfaConfiguration

public final SmsMfaConfigType smsMfaConfiguration()

The SMS text message multi-factor authentication (MFA) configuration.

Returns:

The SMS text message multi-factor authentication (MFA) configuration.

softwareTokenMfaConfiguration

public final SoftwareTokenMfaConfigType softwareTokenMfaConfiguration()

The software token multi-factor authentication (MFA) configuration.

Returns:

The software token multi-factor authentication (MFA) configuration.

mfaConfiguration

public final UserPoolMfaType mfaConfiguration()

The multi-factor authentication (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.

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 multi-factor authentication (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

mfaConfigurationAsString

public final String mfaConfigurationAsString()

The multi-factor authentication (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.

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 multi-factor authentication (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

toBuilder

public GetUserPoolMfaConfigResponse.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<GetUserPoolMfaConfigResponse.Builder,GetUserPoolMfaConfigResponse>

Specified by:

toBuilder in class AwsResponse

builder

public static GetUserPoolMfaConfigResponse.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class AwsResponse

equals

public final boolean equals(Object obj)

Overrides:

equals in class AwsResponse

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 SdkResponse

sdkFields

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

Specified by:

sdkFields in interface SdkPojo