interface AccountRecoverySettingProperty

Language	Type name
.NET	Amazon.CDK.AWS.Cognito.CfnUserPool.AccountRecoverySettingProperty
Java	software.amazon.awscdk.services.cognito.CfnUserPool.AccountRecoverySettingProperty
Python	aws_cdk.aws_cognito.CfnUserPool.AccountRecoverySettingProperty
TypeScript	@aws-cdk/aws-cognito » CfnUserPool » AccountRecoverySettingProperty

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.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cognito from '@aws-cdk/aws-cognito';
const accountRecoverySettingProperty: cognito.CfnUserPool.AccountRecoverySettingProperty = {
  recoveryMechanisms: [{
    name: 'name',
    priority: 123,
  }],
};

Properties

Name	Type	Description
recoveryMechanisms?	IResolvable | IResolvable | RecoveryOptionProperty[]	The list of RecoveryOptionTypes .

---

recoveryMechanisms?

Type: IResolvable | IResolvable | RecoveryOptionProperty[] (optional)

The list of RecoveryOptionTypes .