SignInAliases¶
-
class
aws_cdk.aws_cognito.
SignInAliases
(*, email=None, phone=None, preferred_username=None, username=None)¶ Bases:
object
The different ways in which users of this pool can sign up or sign in.
- Parameters
email (
Optional
[bool
]) – Whether a user is allowed to sign up or sign in with an email address. Default: falsephone (
Optional
[bool
]) – Whether a user is allowed to sign up or sign in with a phone number. Default: falsepreferred_username (
Optional
[bool
]) – 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 withUSERNAME
. Default: falseusername (
Optional
[bool
]) – Whether user is allowed to sign up or sign in with a username. Default: true
- ExampleMetadata
infused
Example:
cognito.UserPool(self, "myuserpool", # ... # ... sign_in_aliases=cognito.SignInAliases( username=True, email=True ) )
Attributes
-
email
¶ Whether a user is allowed to sign up or sign in with an email address.
- Default
false
- Return type
Optional
[bool
]
-
phone
¶ Whether a user is allowed to sign up or sign in with a phone number.
- Default
false
- Return type
Optional
[bool
]
-
preferred_username
¶ 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
- Return type
Optional
[bool
]
-
username
¶ Whether user is allowed to sign up or sign in with a username.
- Default
true
- Return type
Optional
[bool
]