AWS CDK Reference

Appearance

v2.274.0

AuthFlow Struct ​

Types of authentication flow.

Source
aws-cognito/lib/user-pool-client.ts
Type last changed
v2.172.0 · 7 Dec 2024

Example ​

ts
const userPool = new cognito.UserPool(this, 'myuserpool', {
  signInPolicy: {
    allowedFirstAuthFactors: {
      password: true, // password authentication must be enabled
      emailOtp: true, // enables email message one-time password
      smsOtp: true,   // enables SMS message one-time password
      passkey: true,  // enables passkey sign-in
    },
  },
});

// You should also configure the user pool client with USER_AUTH authentication flow allowed
userPool.addClient('myclient', {
  authFlows: { user: true },
});

Properties ​

adminUserPasswordoptionalbooleanadmin_user_passwordoptionalbooladminUserPasswordoptionalBooleanAdminUserPasswordoptionalboolAdminUserPasswordoptional*bool= false#
Enable admin based user password authentication flow.
customoptionalbooleancustomoptionalboolcustomoptionalBooleanCustomoptionalboolCustomoptional*bool= false#
Enable custom authentication flow.
useroptionalbooleanuseroptionalbooluseroptionalBooleanUseroptionalboolUseroptional*bool= false#
Enable Choice-based authentication.
userPasswordoptionalbooleanuser_passwordoptionalbooluserPasswordoptionalBooleanUserPasswordoptionalboolUserPasswordoptional*bool= false#
Enable auth using username & password.
userSrpoptionalbooleanuser_srpoptionalbooluserSrpoptionalBooleanUserSrpoptionalboolUserSrpoptional*bool= false#
Enable SRP based authentication.