Package software.amazon.awscdk.services.cognito

Interface AuthFlow

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

AuthFlow.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-20T23:37:17.283Z")
@Stability(Stable)
public interface AuthFlow
extends software.amazon.jsii.JsiiSerializable

Types of authentication flow.

Example:

 UserPool userPool = UserPool.Builder.create(this, "myuserpool")
         .signInPolicy(SignInPolicy.builder()
                 .allowedFirstAuthFactors(AllowedFirstAuthFactors.builder()
                         .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)
                         .build())
                 .build())
         .build();
 // You should also configure the user pool client with USER_AUTH authentication flow allowed
 userPool.addClient("myclient", UserPoolClientOptions.builder()
         .authFlows(AuthFlow.builder().user(true).build())
         .build());
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	AuthFlow.Builder	A builder for AuthFlow
static final class	AuthFlow.Jsii$Proxy	An implementation for AuthFlow

Method Summary

Modifier and Type	Method	Description
static AuthFlow.Builder	builder()
default Boolean	getAdminUserPassword()	Enable admin based user password authentication flow.
default Boolean	getCustom()	Enable custom authentication flow.
default Boolean	getUser()	Enable Choice-based authentication.
default Boolean	getUserPassword()	Enable auth using username & password.
default Boolean	getUserSrp()	Enable SRP based authentication.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAdminUserPassword

@Stability(Stable)
@Nullable
default Boolean getAdminUserPassword()

Enable admin based user password authentication flow.

Default: false

getCustom

@Stability(Stable)
@Nullable
default Boolean getCustom()

Enable custom authentication flow.

Default: false

getUser

@Stability(Stable)
@Nullable
default Boolean getUser()

Enable Choice-based authentication.

Default: false

getUserPassword

@Stability(Stable)
@Nullable
default Boolean getUserPassword()

Enable auth using username & password.

Default: false

getUserSrp

@Stability(Stable)
@Nullable
default Boolean getUserSrp()

Enable SRP based authentication.

Default: false

builder

@Stability(Stable)
static AuthFlow.Builder builder()

Returns:

a AuthFlow.Builder of AuthFlow