Package software.amazon.awscdk.services.cognito

Interface KeepOriginalAttrs

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
KeepOriginalAttrs.Jsii$Proxy
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)", date="2024-05-08T21:35:04.706Z") @Stability(Stable) public interface KeepOriginalAttrs extends software.amazon.jsii.JsiiSerializable
Attributes that will be kept until the user verifies the changed attribute.

Example: 

 UserPool.Builder.create(this, "myuserpool")
         // ...
         .signInAliases(SignInAliases.builder().username(true).build())
         .autoVerify(AutoVerifiedAttrs.builder().email(true).phone(true).build())
         .keepOriginal(KeepOriginalAttrs.builder()
                 .email(true)
                 .phone(true)
                 .build())
         .build();

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static final class 
    KeepOriginalAttrs.Builder
    A builder for KeepOriginalAttrs
    static final class 
    KeepOriginalAttrs.Jsii$Proxy
    An implementation for KeepOriginalAttrs

  • Method Summary

    Modifier and Type
    Method
    Description
    static KeepOriginalAttrs.Builder
    builder()
     
    default Boolean
    getEmail()
    Whether the email address of the user should remain the original value until the new email address is verified.
    default Boolean
    getPhone()
    Whether the phone number of the user should remain the original value until the new phone number is verified.

    Methods inherited from interface software.amazon.jsii.JsiiSerializable

    $jsii$toJson

  • Method Details

    • getEmail

      @Stability(Stable) @Nullable default Boolean getEmail()
      Whether the email address of the user should remain the original value until the new email address is verified.

      Default: - false

    • getPhone

      @Stability(Stable) @Nullable default Boolean getPhone()
      Whether the phone number of the user should remain the original value until the new phone number is verified.

      Default: - false

    • builder

      @Stability(Stable) static KeepOriginalAttrs.Builder builder()
      Returns:
      a KeepOriginalAttrs.Builder of KeepOriginalAttrs