Package software.amazon.awscdk.services.cognito

Interface CfnUserPool.RecoveryOptionProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnUserPool.RecoveryOptionProperty.Jsii$Proxy

Enclosing class:

CfnUserPool

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

A recovery option for a user.

The AccountRecoverySettingType data type is an array of this object. Each RecoveryOptionType has a priority property that determines whether it is a primary or secondary option.

For example, if verified_email has a priority of 1 and verified_phone_number has a priority of 2 , your user pool sends account-recovery messages to a verified email address but falls back to an SMS message if the user has a verified phone number. The admin_only option prevents self-service account recovery.

This data type is a request and response parameter of CreateUserPool and UpdateUserPool , and a response parameter of DescribeUserPool .

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.*;
 RecoveryOptionProperty recoveryOptionProperty = RecoveryOptionProperty.builder()
         .name("name")
         .priority(123)
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnUserPool.RecoveryOptionProperty.Builder	builder()
default String	getName()	The recovery method that this object sets a recovery option for.
default Number	getPriority()	Your priority preference for using the specified attribute in account recovery.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@Nullable
default String getName()

The recovery method that this object sets a recovery option for.

See Also:

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

getPriority

@Stability(Stable)
@Nullable
default Number getPriority()

Your priority preference for using the specified attribute in account recovery.

The highest priority is 1 .

See Also:

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

builder

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

Returns:

a CfnUserPool.RecoveryOptionProperty.Builder of CfnUserPool.RecoveryOptionProperty