Class: Aws::WAFV2::Types::ManagedRuleGroupConfig

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

Overview

Additional information that’s used by a managed rule group. Many managed rule groups don’t require this.

The rule groups used for intelligent threat mitigation require additional configuration:

  • Use the ‘AWSManagedRulesACFPRuleSet` configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields.

  • Use the ‘AWSManagedRulesATPRuleSet` configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password.

  • Use the ‘AWSManagedRulesBotControlRuleSet` configuration object to configure the protection level that you want the Bot Control rule group to use.

For example specifications, see the examples section of CreateWebACL.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_managed_rules_acfp_rule_setTypes::AWSManagedRulesACFPRuleSet

Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, ‘AWSManagedRulesACFPRuleSet`. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.

For information about using the ACFP managed rule group, see [WAF Fraud Control account creation fraud prevention (ACFP) rule group] and [WAF Fraud Control account creation fraud prevention (ACFP)] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html



5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#aws_managed_rules_atp_rule_setTypes::AWSManagedRulesATPRuleSet

Additional configuration for using the account takeover prevention (ATP) managed rule group, ‘AWSManagedRulesATPRuleSet`. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.

This configuration replaces the individual configuration fields in ‘ManagedRuleGroupConfig` and provides additional feature configuration.

For information about using the ATP managed rule group, see [WAF Fraud Control account takeover prevention (ATP) rule group] and

WAF Fraud Control account takeover prevention (ATP)][2

in the *WAF

Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html



5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#aws_managed_rules_bot_control_rule_setTypes::AWSManagedRulesBotControlRuleSet

Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see [WAF Bot Control rule group] and [WAF Bot Control] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html



5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#login_pathString

<note markdown=“1”> Instead of this setting, provide your configuration under ‘AWSManagedRulesATPRuleSet`.

</note>

Returns:

  • (String)


5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#password_fieldTypes::PasswordField

<note markdown=“1”> Instead of this setting, provide your configuration under the request inspection configuration for ‘AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.

</note>


5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#payload_typeString

<note markdown=“1”> Instead of this setting, provide your configuration under the request inspection configuration for ‘AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.

</note>

Returns:

  • (String)


5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end

#username_fieldTypes::UsernameField

<note markdown=“1”> Instead of this setting, provide your configuration under the request inspection configuration for ‘AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`.

</note>


5423
5424
5425
5426
5427
5428
5429
5430
5431
5432
5433
# File 'lib/aws-sdk-wafv2/types.rb', line 5423

class ManagedRuleGroupConfig < Struct.new(
  :login_path,
  :payload_type,
  :username_field,
  :password_field,
  :aws_managed_rules_bot_control_rule_set,
  :aws_managed_rules_atp_rule_set,
  :aws_managed_rules_acfp_rule_set)
  SENSITIVE = []
  include Aws::Structure
end