AWS::Cognito::UserPool RecoveryOption
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 and UpdateUserPool, and a response parameter of DescribeUserPool.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
Properties
Name
-
The recovery method that this object sets a recovery option for.
Required: No
Type: String
Allowed values:
verified_email | verified_phone_number | admin_only
Update requires: No interruption
Priority
-
Your priority preference for using the specified attribute in account recovery. The highest priority is
1
.Required: No
Type: Integer
Minimum:
1
Maximum:
2
Update requires: No interruption