aws-cdk-lib.aws_cognito.AuthFlow

interface AuthFlow

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

Types of authentication flow.

See also: https://docs.aws.amazon.com/cognito/latest/developerguide/amazon-cognito-user-pools-authentication-flow.html

Example

const pool = new cognito.UserPool(this, 'pool');
pool.addClient('app-client', {
  authFlows: {
    userPassword: true,
    userSrp: true,
  },
});

Properties

NameTypeDescription
adminUserPassword?booleanEnable admin based user password authentication flow.
custom?booleanEnable custom authentication flow.
userPassword?booleanEnable auth using username & password.
userSrp?booleanEnable SRP based authentication.

adminUserPassword?

Type: boolean (optional, default: false)

Enable admin based user password authentication flow.


custom?

Type: boolean (optional, default: false)

Enable custom authentication flow.


userPassword?

Type: boolean (optional, default: false)

Enable auth using username & password.


userSrp?

Type: boolean (optional, default: false)

Enable SRP based authentication.