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

Class: Aws::CognitoIdentityProvider::Types::AccountTakeoverRiskConfigurationType

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 AccountTakeoverRiskConfigurationType data as a hash:

{
  notify_configuration: {
    from: "StringType",
    reply_to: "StringType",
    source_arn: "ArnType", # required
    block_email: {
      subject: "EmailNotificationSubjectType", # required
      html_body: "EmailNotificationBodyType",
      text_body: "EmailNotificationBodyType",
    },
    no_action_email: {
      subject: "EmailNotificationSubjectType", # required
      html_body: "EmailNotificationBodyType",
      text_body: "EmailNotificationBodyType",
    },
    mfa_email: {
      subject: "EmailNotificationSubjectType", # required
      html_body: "EmailNotificationBodyType",
      text_body: "EmailNotificationBodyType",
    },
  },
  actions: { # required
    low_action: {
      notify: false, # required
      event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
    },
    medium_action: {
      notify: false, # required
      event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
    },
    high_action: {
      notify: false, # required
      event_action: "BLOCK", # required, accepts BLOCK, MFA_IF_CONFIGURED, MFA_REQUIRED, NO_ACTION
    },
  },
}

Configuration for mitigation actions and notification for different levels of risk detected for a potential account takeover.

Instance Attribute Summary collapse

Instance Attribute Details

#actionsTypes::AccountTakeoverActionsType

Account takeover risk configuration actions



141
142
143
144
145
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 141

class AccountTakeoverRiskConfigurationType < Struct.new(
  :notify_configuration,
  :actions)
  include Aws::Structure
end

#notify_configurationTypes::NotifyConfigurationType

The notify configuration used to construct email notifications.



141
142
143
144
145
# File 'gems/aws-sdk-cognitoidentityprovider/lib/aws-sdk-cognitoidentityprovider/types.rb', line 141

class AccountTakeoverRiskConfigurationType < Struct.new(
  :notify_configuration,
  :actions)
  include Aws::Structure
end