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

Inherits:

Struct

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

Includes:

Structure

Defined in:

lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #name ⇒ String

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

• #priority ⇒ Integer

  Your priority preference for using the specified attribute in account recovery.

Instance Attribute Details

#name ⇒ String

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

Returns:

• (String)

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

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

#priority ⇒ Integer

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

Returns:

• (Integer)

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

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