interface AccountRecoverySettingProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.Cognito.CfnUserPoolPropsMixin.AccountRecoverySettingProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscognito#CfnUserPoolPropsMixin_AccountRecoverySettingProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.AccountRecoverySettingProperty |
 Python | aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolPropsMixin.AccountRecoverySettingProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_cognito » CfnUserPoolPropsMixin » AccountRecoverySettingProperty |
The available verified method a user can use to recover their password when they call ForgotPassword .
You can use this setting to define a preferred method when a user has more than one method available. With this setting, SMS doesn't qualify for a valid password recovery mechanism if the user also has SMS multi-factor authentication (MFA) activated. In the absence of this setting, Amazon Cognito uses the legacy behavior to determine the recovery method where SMS is preferred through email.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from '@aws-cdk/cfn-property-mixins';
const accountRecoverySettingProperty: cognito.CfnUserPoolPropsMixin.AccountRecoverySettingProperty = {
recoveryMechanisms: [{
name: 'name',
priority: 123,
}],
};
Properties
| Name | Type | Description |
|---|---|---|
| recovery | IResolvable | (IResolvable | Recovery)[] | The list of options and priorities for user message delivery in forgot-password operations. |
recoveryMechanisms?
Type:
IResolvable | (IResolvable | Recovery)[]
(optional)
The list of options and priorities for user message delivery in forgot-password operations.
Sets or displays user pool preferences for email or SMS message priority, whether users should fall back to a second delivery method, and whether passwords should only be reset by administrators.