Class CfnUserPool.AccountRecoverySettingProperty

Namespace

Amazon.CDK.AWS.Cognito

Assembly

Amazon.CDK.AWS.Cognito.dll

Use this setting to define which verified available method a user can use to recover their password when they call ForgotPassword .

public class CfnUserPool.AccountRecoverySettingProperty : CfnUserPool.IAccountRecoverySettingProperty

Inheritance

object

CfnUserPool.AccountRecoverySettingProperty

Implements

CfnUserPool.IAccountRecoverySettingProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Cognito;

             var accountRecoverySettingProperty = new AccountRecoverySettingProperty {
                 RecoveryMechanisms = new [] { new RecoveryOptionProperty {
                     Name = "name",
                     Priority = 123
                 } }
             };

Remarks

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.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html

ExampleMetadata: fixture=_generated

Constructors

AccountRecoverySettingProperty()

public AccountRecoverySettingProperty()

Properties

RecoveryMechanisms

The list of RecoveryOptionTypes .

public object? RecoveryMechanisms { get; set; }

Property Value

object

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cognito-userpool-accountrecoverysetting.html#cfn-cognito-userpool-accountrecoverysetting-recoverymechanisms