KeepOriginalAttrs

class aws_cdk.aws_cognito.KeepOriginalAttrs(*, email=None, phone=None)

Bases: object

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

Parameters
  • email (Optional[bool]) – Whether the email address of the user should remain the original value until the new email address is verified. Default: - false

  • phone (Optional[bool]) – Whether the phone number of the user should remain the original value until the new phone number is verified. Default: - false

ExampleMetadata

infused

Example:

cognito.UserPool(self, "myuserpool",
    # ...
    sign_in_aliases=cognito.SignInAliases(username=True),
    auto_verify=cognito.AutoVerifiedAttrs(email=True, phone=True),
    keep_original=cognito.KeepOriginalAttrs(
        email=True,
        phone=True
    )
)

Attributes

email

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

Default
  • false

Return type

Optional[bool]

phone

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

Default
  • false

Return type

Optional[bool]