Interface ISignInAliases
The different ways in which users of this pool can sign up or sign in.
Namespace: Amazon.CDK.AWS.Cognito
Assembly: Amazon.CDK.AWS.Cognito.dll
Syntax (csharp)
public interface ISignInAliases
Syntax (vb)
Public Interface ISignInAliases
Remarks
ExampleMetadata: infused
Examples
new UserPool(this, "myuserpool", new UserPoolProps {
// ...
// ...
SignInAliases = new SignInAliases {
Username = true,
Email = true
}
});
Synopsis
Properties
Whether a user is allowed to sign up or sign in with an email address. |
|
Phone | Whether a user is allowed to sign up or sign in with a phone number. |
PreferredUsername | Whether a user is allowed to sign in with a secondary username, that can be set and modified after sign up. |
Username | Whether user is allowed to sign up or sign in with a username. |
Properties
Whether a user is allowed to sign up or sign in with an email address.
virtual Nullable<bool> Email { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Phone
Whether a user is allowed to sign up or sign in with a phone number.
virtual Nullable<bool> Phone { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
PreferredUsername
Whether a user is allowed to sign in with a secondary username, that can be set and modified after sign up.
virtual Nullable<bool> PreferredUsername { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Can only be used in conjunction with USERNAME
.
Default: false
Username
Whether user is allowed to sign up or sign in with a username.
virtual Nullable<bool> Username { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: true