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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

Note:

When making an API call, you may pass RecoveryOptionType data as a 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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#nameString

The recovery method for a user.

Returns:

  • (String)


7484
7485
7486
7487
7488
7489
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7484

class RecoveryOptionType < Struct.new(
  :priority,
  :name)
  SENSITIVE = []
  include Aws::Structure
end

#priorityInteger

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

Returns:

  • (Integer)


7484
7485
7486
7487
7488
7489
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7484

class RecoveryOptionType < Struct.new(
  :priority,
  :name)
  SENSITIVE = []
  include Aws::Structure
end