interface RecoveryOptionProperty
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.CfnPropertyMixins.AWS.Cognito.CfnUserPoolPropsMixin.RecoveryOptionProperty |
 Go | github.com/aws/aws-cdk-go/awscdkcfnpropertymixins/v2/awscognito#CfnUserPoolPropsMixin_RecoveryOptionProperty |
 Java | software.amazon.awscdk.cfnpropertymixins.services.cognito.CfnUserPoolPropsMixin.RecoveryOptionProperty |
 Python | aws_cdk.cfn_property_mixins.aws_cognito.CfnUserPoolPropsMixin.RecoveryOptionProperty |
 TypeScript | @aws-cdk/cfn-property-mixins » aws_cognito » CfnUserPoolPropsMixin » RecoveryOptionProperty |
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.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_cognito as cognito } from '@aws-cdk/cfn-property-mixins';
const recoveryOptionProperty: cognito.CfnUserPoolPropsMixin.RecoveryOptionProperty = {
name: 'name',
priority: 123,
};
Properties
| Name | Type | Description |
|---|---|---|
| name? | string | The recovery method that this object sets a recovery option for. |
| priority? | number | Your priority preference for using the specified attribute in account recovery. |
name?
Type:
string
(optional)
The recovery method that this object sets a recovery option for.
priority?
Type:
number
(optional)
Your priority preference for using the specified attribute in account recovery.
The highest priority is 1 .