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.29.0 (build 41df200)",
           date="2021-06-02T09:55:16.766Z")
 @Stability(value=Experimental)
public interface SignInAliases
extends software.amazon.jsii.JsiiSerializable

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

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 Boolean	getEmail() (experimental) Whether a user is allowed to sign up or sign in with an email address.
default Boolean	getPhone() (experimental) Whether a user is allowed to sign up or sign in with a phone number.
default Boolean	getPreferredUsername() (experimental) Whether a user is allowed to sign in with a secondary username, that can be set and modified after sign up.
default Boolean	getUsername() (experimental) Whether user is allowed to sign up or sign in with a username.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEmail

@Stability(value=Experimental)
 @Nullable
default Boolean getEmail()

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

Default: false

getPhone

@Stability(value=Experimental)
 @Nullable
default Boolean getPhone()

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

Default: false

getPreferredUsername

@Stability(value=Experimental)
 @Nullable
default Boolean getPreferredUsername()

(experimental) 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(value=Experimental)
 @Nullable
default Boolean getUsername()

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

Default: true

builder

@Stability(value=Experimental)
static SignInAliases.Builder builder()

Returns:

a SignInAliases.Builder of SignInAliases