Class: Aws::CognitoIdentityProvider::Types::AccountTakeoverActionType

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-cognitoidentityprovider/types.rb

Overview

The automated response to a risk level for adaptive authentication in full-function, or ‘ENFORCED`, mode. You can assign an action to each risk level that advanced security features evaluates.

This data type is a request parameter of [SetRiskConfiguration] and a response parameter of [DescribeRiskConfiguration].

[1]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_SetRiskConfiguration.html [2]: docs.aws.amazon.com/cognito-user-identity-pools/latest/APIReference/API_DescribeRiskConfiguration.html

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#event_action ⇒ String

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:

  • (String) 


83
84
85
86
87
88
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 83

class AccountTakeoverActionType < Struct.new(
  :notify,
  :event_action)
  SENSITIVE = []
  include Aws::Structure
end

#notify ⇒ Boolean

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:

  • (Boolean) 


83
84
85
86
87
88
 
# File 'lib/aws-sdk-cognitoidentityprovider/types.rb', line 83

class AccountTakeoverActionType < Struct.new(
  :notify,
  :event_action)
  SENSITIVE = []
  include Aws::Structure
end