Package software.amazon.awscdk.services.cognito

Interface SignInAliases

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

SignInAliases.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:44.052Z")
@Stability(Stable)
public interface SignInAliases
extends software.amazon.jsii.JsiiSerializable

The different ways in which users of this pool can sign up or sign in.

Example:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SignInAliases.Builder	builder()
default Boolean	getEmail()	Whether a user is allowed to sign up or sign in with an email address.
default Boolean	getPhone()	Whether a user is allowed to sign up or sign in with a phone number.
default Boolean	getPreferredUsername()	Whether a user is allowed to sign in with a secondary username, that can be set and modified after sign up.
default Boolean	getUsername()	Whether user is allowed to sign up or sign in with a username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getEmail

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

Whether a user is allowed to sign up or sign in with an email address.

Default: false

getPhone

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

Whether a user is allowed to sign up or sign in with a phone number.

Default: false

getPreferredUsername

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

Whether a user is allowed to sign in with a secondary username, that can be set and modified after sign up.

Can only be used in conjunction with USERNAME.

Default: false

getUsername

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

Whether user is allowed to sign up or sign in with a username.

Default: true

builder

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

Returns:

a SignInAliases.Builder of SignInAliases