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

Inherits:

Struct

• Object
• Struct
• Aws::CognitoIdentityProvider::Types::RecoveryOptionType

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

  The recovery method for a user.

• #priority ⇒ Integer

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

Instance Attribute Details

#name ⇒ String

The recovery method for a user.

Returns:

• (String)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7484

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

#priority ⇒ Integer

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

Returns:

• (Integer)

# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 7484

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