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

Class RecoveryOptionType

java.lang.Object

software.amazon.awssdk.services.cognitoidentityprovider.model.RecoveryOptionType

All Implemented Interfaces:

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

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

A recovery option for a user. The AccountRecoverySettingType data type is an array of this object. Each RecoveryOptionType has a priority property that determines whether it is a primary or secondary option.

For example, if verified_email has a priority of 1 and verified_phone_number has a priority of 2, your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The admin_only option prevents self-service account recovery.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool, and a response parameter of DescribeUserPool.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	RecoveryOptionType.Builder

Method Summary

Modifier and Type	Method	Description
static RecoveryOptionType.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
RecoveryOptionNameType	name()	The recovery method that this object sets a recovery option for.
String	nameAsString()	The recovery method that this object sets a recovery option for.
Integer	priority()	Your priority preference for using the specified attribute in account recovery.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends RecoveryOptionType.Builder>	serializableBuilderClass()
RecoveryOptionType.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

priority

public final Integer priority()

Your priority preference for using the specified attribute in account recovery. The highest priority is 1.

Returns:

Your priority preference for using the specified attribute in account recovery. The highest priority is 1.

name

public final RecoveryOptionNameType name()

The recovery method that this object sets a recovery option for.

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

Returns:

The recovery method that this object sets a recovery option for.

See Also:

RecoveryOptionNameType

nameAsString

public final String nameAsString()

The recovery method that this object sets a recovery option for.

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

Returns:

The recovery method that this object sets a recovery option for.

See Also:

RecoveryOptionNameType

toBuilder

public RecoveryOptionType.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<RecoveryOptionType.Builder,RecoveryOptionType>

builder

public static RecoveryOptionType.Builder builder()

serializableBuilderClass

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

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

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)

sdkFields

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

Specified by:

sdkFields in interface SdkPojo

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo