aws-cdk-lib.aws_cognito.KeepOriginalAttrs

interface KeepOriginalAttrs

LanguageType name
.NETAmazon.CDK.AWS.Cognito.KeepOriginalAttrs
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#KeepOriginalAttrs
Javasoftware.amazon.awscdk.services.cognito.KeepOriginalAttrs
Pythonaws_cdk.aws_cognito.KeepOriginalAttrs
TypeScript (source)aws-cdk-lib » aws_cognito » KeepOriginalAttrs

Attributes that will be kept until the user verifies the changed attribute.

Example

new cognito.UserPool(this, 'myuserpool', {
  // ...
  signInAliases: { username: true },
  autoVerify: { email: true, phone: true },
  keepOriginal: {
    email: true,
    phone: true,
  },
});

Properties

NameTypeDescription
email?booleanWhether the email address of the user should remain the original value until the new email address is verified.
phone?booleanWhether the phone number of the user should remain the original value until the new phone number is verified.

email?

Type: boolean (optional, default: false)

Whether the email address of the user should remain the original value until the new email address is verified.


phone?

Type: boolean (optional, default: false)

Whether the phone number of the user should remain the original value until the new phone number is verified.