aws-cdk-lib.aws_cognito.SignInAliases

interface SignInAliases

LanguageType name
.NETAmazon.CDK.AWS.Cognito.SignInAliases
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awscognito#SignInAliases
Javasoftware.amazon.awscdk.services.cognito.SignInAliases
Pythonaws_cdk.aws_cognito.SignInAliases
TypeScript (source)aws-cdk-lib » aws_cognito » SignInAliases

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

Example

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

Properties

NameTypeDescription
email?booleanWhether a user is allowed to sign up or sign in with an email address.
phone?booleanWhether a user is allowed to sign up or sign in with a phone number.
preferredUsername?booleanWhether a user is allowed to sign in with a secondary username, that can be set and modified after sign up.
username?booleanWhether user is allowed to sign up or sign in with a username.

email?

Type: boolean (optional, default: false)

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


phone?

Type: boolean (optional, default: false)

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


preferredUsername?

Type: boolean (optional, default: 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.


username?

Type: boolean (optional, default: true)

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