Package software.amazon.awssdk.services.cognitoidentityprovider.model

Interface AccountTakeoverActionType.Builder

All Superinterfaces:
Buildable, CopyableBuilder<AccountTakeoverActionType.Builder,AccountTakeoverActionType>, SdkBuilder<AccountTakeoverActionType.Builder,AccountTakeoverActionType>, SdkPojo
Enclosing class:
AccountTakeoverActionType
@Mutable @NotThreadSafe public static interface AccountTakeoverActionType.Builder extends SdkPojo, CopyableBuilder<AccountTakeoverActionType.Builder,AccountTakeoverActionType>

  • Method Details

    • eventAction

      AccountTakeoverActionType.Builder eventAction(String eventAction)

      The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

      • BLOCK: Block the request.

      • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

      • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

      • NO_ACTION: Take no action. Permit sign-in.

      Parameters:
      eventAction - The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

      • BLOCK: Block the request.

      • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

      • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

      • NO_ACTION: Take no action. Permit sign-in.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • eventAction

      AccountTakeoverActionType.Builder eventAction(AccountTakeoverEventActionType eventAction)

      The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

      • BLOCK: Block the request.

      • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

      • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

      • NO_ACTION: Take no action. Permit sign-in.

      Parameters:
      eventAction - The action to take for the attempted account takeover action for the associated risk level. Valid values are as follows:

      • BLOCK: Block the request.

      • MFA_IF_CONFIGURED: Present an MFA challenge if possible. MFA is possible if the user pool has active MFA methods that the user can set up. For example, if the user pool only supports SMS message MFA but the user doesn't have a phone number attribute, MFA setup isn't possible. If MFA setup isn't possible, allow the request.

      • MFA_REQUIRED: Present an MFA challenge if possible. Block the request if a user hasn't set up MFA. To sign in with required MFA, users must have an email address or phone number attribute, or a registered TOTP factor.

      • NO_ACTION: Take no action. Permit sign-in.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • sendNotification

      AccountTakeoverActionType.Builder sendNotification(Boolean sendNotification)

      Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.

      Parameters:
      sendNotification - Determines whether Amazon Cognito sends a user a notification message when your user pools assesses a user's session at the associated risk level.
      Returns:
      Returns a reference to this object so that method calls can be chained together.