Interface AuthFlow

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
AuthFlow.Jsii$Proxy

@Generated(value="jsii-pacmak/1.103.1 (build bef2dea)", date="2024-10-25T14:21:12.411Z") @Stability(Stable) public interface AuthFlow extends software.amazon.jsii.JsiiSerializable
Types of authentication flow.

Example:

 UserPool pool = new UserPool(this, "pool");
 pool.addClient("app-client", UserPoolClientOptions.builder()
         .authFlows(AuthFlow.builder()
                 .userPassword(true)
                 .userSrp(true)
                 .build())
         .build());
 

See Also:
  • 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

    • 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