software.amazon.awscdk.services.cognito

Interface SignInAliases

All Known Implementing Classes:

SignInAliases.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:46.876Z")
public interface SignInAliases

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 and Description
static class	SignInAliases.Builder A builder for SignInAliases
static class	SignInAliases.Jsii$Proxy An implementation for SignInAliases

Method Summary

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

Method Detail

getEmail

default java.lang.Boolean getEmail()

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

Default: false

getPhone

default java.lang.Boolean getPhone()

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

Default: false

getPreferredUsername

default java.lang.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

default java.lang.Boolean getUsername()

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

Default: true

builder

static SignInAliases.Builder builder()

Returns:

a SignInAliases.Builder of SignInAliases