You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::CognitoIdentityProvider::Types::RecoveryOptionType

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing RecoveryOptionType as input to an Aws::Client method, you can use a vanilla Hash:

{
  priority: 1, # required
  name: "verified_email", # required, accepts verified_email, verified_phone_number, admin_only
}

A map containing a priority as a key, and recovery method name as a value.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

Specifies the recovery method for a user.

Possible values:

  • verified_email
  • verified_phone_number
  • admin_only

Returns:

  • (String) —

    Specifies the recovery method for a user.

#priority ⇒ Integer

A positive integer specifying priority of a method with 1 being the highest priority.

Returns:

  • (Integer) —

    A positive integer specifying priority of a method with 1 being the highest priority.