software.amazon.awssdk.services.cognitoidentityprovider.model

Class MFAOptionType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.MFAOptionType

All Implemented Interfaces:

Serializable, SdkPojo, ToCopyableBuilder<MFAOptionType.Builder,MFAOptionType>

@Generated(value="software.amazon.awssdk:codegen")
public final class MFAOptionType
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<MFAOptionType.Builder,MFAOptionType>

This data type is no longer supported. You can use it only for SMS MFA configurations. You can't use it for TOTP software token MFA configurations.

To set either type of MFA configuration, use the AdminSetUserMFAPreference or SetUserMFAPreference actions.

To look up information about either type of MFA configuration, use the AdminGetUserResponse$UserMFASettingList or GetUserResponse$UserMFASettingList responses.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MFAOptionType.Builder

Method Summary

Modifier and Type	Method and Description
String	attributeName() The attribute name of the MFA option type.
static MFAOptionType.Builder	builder()
DeliveryMediumType	deliveryMedium() The delivery medium to send the MFA code.
String	deliveryMediumAsString() The delivery medium to send the MFA code.
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
List<SdkField<?>>	sdkFields()
static Class<? extends MFAOptionType.Builder>	serializableBuilderClass()
MFAOptionType.Builder	toBuilder()
String	toString() Returns a string representation of this object.

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

deliveryMedium

public DeliveryMediumType deliveryMedium()

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

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

Returns:

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

See Also:

DeliveryMediumType

deliveryMediumAsString

public String deliveryMediumAsString()

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

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

Returns:

The delivery medium to send the MFA code. You can use this parameter to set only the SMS delivery medium value.

See Also:

DeliveryMediumType

attributeName

public String attributeName()

The attribute name of the MFA option type. The only valid value is phone_number.

Returns:

The attribute name of the MFA option type. The only valid value is phone_number.

toBuilder

public MFAOptionType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<MFAOptionType.Builder,MFAOptionType>

builder

public static MFAOptionType.Builder builder()

serializableBuilderClass

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

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

equalsBySdkFields

public boolean equalsBySdkFields(Object obj)

Specified by:

equalsBySdkFields in interface SdkPojo

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

getValueForField

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

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo