AWS CDK Reference

Appearance

v2.274.0

SignInAliases Struct ​

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

Source
aws-cognito/lib/user-pool.ts

Example ​

ts
new cognito.UserPool(this, 'myuserpool', {
  // ...
  // ...
  signInAliases: { username: true, email: true },
  autoVerify: { email: true, phone: true },
});

Properties ​

emailoptionalbooleanemailoptionalboolemailoptionalBooleanEmailoptionalboolEmailoptional*bool= false#
Whether a user is allowed to sign up or sign in with an email address.
phoneoptionalbooleanphoneoptionalboolphoneoptionalBooleanPhoneoptionalboolPhoneoptional*bool= false#
Whether a user is allowed to sign up or sign in with a phone number.
preferredUsernameoptionalbooleanpreferred_usernameoptionalboolpreferredUsernameoptionalBooleanPreferredUsernameoptionalboolPreferredUsernameoptional*bool= false#
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.

usernameoptionalbooleanusernameoptionalboolusernameoptionalBooleanUsernameoptionalboolUsernameoptional*bool= true#
Whether user is allowed to sign up or sign in with a username.