AWS::Cognito::UserPool AccountRecoverySetting - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

AWS::Cognito::UserPool AccountRecoverySetting

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword. It allows you to define a preferred method when a user has more than one method available. With this setting, SMS does not qualify for a valid password recovery mechanism if the user also has SMS MFA enabled. In the absence of this setting, Cognito uses the legacy behavior to determine the recovery method where SMS is preferred over email.

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "RecoveryMechanisms" : [ RecoveryOption, ... ] }

Properties

RecoveryMechanisms

The list of RecoveryOptionTypes.

Required: No

Type: Array of RecoveryOption

Minimum: 1

Maximum: 2

Update requires: No interruption