Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.AccountRecoverySettingProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.AccountRecoverySettingProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

@Stability(Stable)
public static interface CfnUserPool.AccountRecoverySettingProperty
extends software.amazon.jsii.JsiiSerializable

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

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.AccountRecoverySettingProperty.Builder	builder()
default Object	getRecoveryMechanisms()	The list of options and priorities for user message delivery in forgot-password operations.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getRecoveryMechanisms

@Stability(Stable)
@Nullable
default Object getRecoveryMechanisms()

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.

See Also:

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

builder

@Stability(Stable)
static CfnUserPool.AccountRecoverySettingProperty.Builder builder()

Returns:

a CfnUserPool.AccountRecoverySettingProperty.Builder of CfnUserPool.AccountRecoverySettingProperty