You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Note:

When making an API call, you may pass AccountTakeoverActionType data as a hash:

{
  notify: false, # required
  event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
}

Account takeover action type.

Instance Attribute Summary collapse

Instance Attribute Details

#event_actionString

The event action.

  • BLOCK Choosing this action will block the request.

  • MFA_IF_CONFIGURED Throw MFA challenge if user has configured it, else allow the request.

  • MFA_REQUIRED Throw MFA challenge if user has configured it, else block the request.

  • NO_ACTION Allow the user sign-in.

Returns:

  • (String)


41
42
43
44
45
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 41

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

#notifyBoolean

Flag specifying whether to send a notification.

Returns:

  • (Boolean)


41
42
43
44
45
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 41

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