cognitoidentityprovider/aws.sdk.kotlin.services.cognitoidentityprovider.model/RecoveryOptionType

RecoveryOptionType

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

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard
val name: RecoveryOptionNameType

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

Link copied to clipboard
val priority: Int

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

Functions

Link copied to clipboard
inline fun copy(block: RecoveryOptionType.Builder.() -> Unit = {}): RecoveryOptionType
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String
© 2025, Amazon Web Services, Inc. or its affiliates. All rights reserved. Generated by dokka