software.amazon.awscdk.services.cognito

Enum AccountRecovery

java.lang.Object

java.lang.Enum<AccountRecovery>

software.amazon.awscdk.services.cognito.AccountRecovery

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AccountRecovery>

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:57.225Z")
public enum AccountRecovery
extends java.lang.Enum<AccountRecovery>

How will a user be able to recover their account?

When a user forgets their password, they can have a code sent to their verified email or verified phone to recover their account. You can choose the preferred way to send codes below. We recommend not allowing phone to be used for both password resets and multi-factor authentication (MFA).

Example:

 UserPool.Builder.create(this, "UserPool")
         // ...
         .accountRecovery(AccountRecovery.EMAIL_ONLY)
         .build();
 

See Also:

https://docs.aws.amazon.com/cognito/latest/developerguide/how-to-recover-a-user-account.html

Enum Constant Summary

Enum Constants

Enum Constant and Description
EMAIL_AND_PHONE_WITHOUT_MFA Email if available, otherwise phone, but don’t allow a user to reset their password via phone if they are also using it for MFA.
EMAIL_ONLY Email only.
NONE None – users will have to contact an administrator to reset their passwords.
PHONE_AND_EMAIL (Not Recommended) Phone if available, otherwise email, and do allow a user to reset their password via phone if they are also using it for MFA.
PHONE_ONLY_WITHOUT_MFA Phone only, but don’t allow a user to reset their password via phone if they are also using it for MFA.
PHONE_WITHOUT_MFA_AND_EMAIL Phone if available, otherwise email, but don’t allow a user to reset their password via phone if they are also using it for MFA.

Method Summary

Modifier and Type	Method and Description
static AccountRecovery	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AccountRecovery[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

EMAIL_AND_PHONE_WITHOUT_MFA

public static final AccountRecovery EMAIL_AND_PHONE_WITHOUT_MFA

Email if available, otherwise phone, but don’t allow a user to reset their password via phone if they are also using it for MFA.

PHONE_WITHOUT_MFA_AND_EMAIL

public static final AccountRecovery PHONE_WITHOUT_MFA_AND_EMAIL

Phone if available, otherwise email, but don’t allow a user to reset their password via phone if they are also using it for MFA.

EMAIL_ONLY

public static final AccountRecovery EMAIL_ONLY

Email only.

PHONE_ONLY_WITHOUT_MFA

public static final AccountRecovery PHONE_ONLY_WITHOUT_MFA

Phone only, but don’t allow a user to reset their password via phone if they are also using it for MFA.

PHONE_AND_EMAIL

public static final AccountRecovery PHONE_AND_EMAIL

(Not Recommended) Phone if available, otherwise email, and do allow a user to reset their password via phone if they are also using it for MFA.

NONE

public static final AccountRecovery NONE

None – users will have to contact an administrator to reset their passwords.

Method Detail

values

public static AccountRecovery[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (AccountRecovery c : AccountRecovery.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static AccountRecovery valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null