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

Inherits:
Struct
  • Object
show all
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.

This data type is a request and response parameter of

CreateUserPool][1

and [UpdateUserPool], and a response parameter

of [DescribeUserPool].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_CreateUserPool.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_UpdateUserPool.html [3]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeUserPool.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#name ⇒ String

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

Returns:

  • (String) 


8895
8896
8897
8898
8899
8900
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8895

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) 


8895
8896
8897
8898
8899
8900
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 8895

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