Interface CfnUserPool.IAccountRecoverySettingProperty

The available verified method a user can use to recover their password when they call ForgotPassword .

Namespace: Amazon.CDK.AWS.Cognito

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnUserPool.IAccountRecoverySettingProperty

Syntax (vb)

Public Interface CfnUserPool.IAccountRecoverySettingProperty

Remarks

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.

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

ExampleMetadata: fixture=_generated

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
                 } }
             };

Synopsis

Properties

RecoveryMechanisms

The list of options and priorities for user message delivery in forgot-password operations.

Properties

RecoveryMechanisms

The list of options and priorities for user message delivery in forgot-password operations.

object? RecoveryMechanisms { get; }

Property Value

object

Remarks

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.

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

Type union: either IResolvable or (either IResolvable or CfnUserPool.IRecoveryOptionProperty)[]