Package software.amazon.awscdk.services.cognito

Interface AutoVerifiedAttrs

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AutoVerifiedAttrs.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-06T23:25:06.297Z")
@Stability(Stable)
public interface AutoVerifiedAttrs
extends software.amazon.jsii.JsiiSerializable

Attributes that can be automatically verified for users in a user pool.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static AutoVerifiedAttrs.Builder	builder()
default Boolean	getEmail()	Whether the email address of the user should be auto verified at sign up.
default Boolean	getPhone()	Whether the phone number of the user should be auto verified at sign up.

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 be auto verified at sign up.

Note: If both email and phone is set, Cognito only verifies the phone number. To also verify email, see here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-email-phone-verification.html

Default: - true, if email is turned on for `signIn`. false, otherwise.

getPhone

@Stability(Stable)
@Nullable
default Boolean getPhone()

Whether the phone number of the user should be auto verified at sign up.

Default: - true, if phone is turned on for `signIn`. false, otherwise.

builder

@Stability(Stable)
static AutoVerifiedAttrs.Builder builder()

Returns:

a AutoVerifiedAttrs.Builder of AutoVerifiedAttrs