software.amazon.awscdk.services.cognito

Interface CfnUserPool.AccountRecoverySettingProperty

All Known Implementing Classes:

CfnUserPool.AccountRecoverySettingProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

public static interface 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 software.amazon.awscdk.services.cognito.*;
 AccountRecoverySettingProperty accountRecoverySettingProperty = AccountRecoverySettingProperty.builder()
         .recoveryMechanisms(List.of(RecoveryOptionProperty.builder()
                 .name("name")
                 .priority(123)
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnUserPool.AccountRecoverySettingProperty.Builder A builder for CfnUserPool.AccountRecoverySettingProperty
static class	CfnUserPool.AccountRecoverySettingProperty.Jsii$Proxy An implementation for CfnUserPool.AccountRecoverySettingProperty

Method Summary

Modifier and Type	Method and Description
static CfnUserPool.AccountRecoverySettingProperty.Builder	builder()
default java.lang.Object	getRecoveryMechanisms() The list of `RecoveryOptionTypes` .

Method Detail

getRecoveryMechanisms

default java.lang.Object getRecoveryMechanisms()

The list of `RecoveryOptionTypes` .

builder

static CfnUserPool.AccountRecoverySettingProperty.Builder builder()

Returns:

a CfnUserPool.AccountRecoverySettingProperty.Builder of CfnUserPool.AccountRecoverySettingProperty