Skip to content

ManagedRuleGroupConfig

Source code in docs_src/capo_wafv2/types/managed_rule_group_config.py
class ManagedRuleGroupConfig(TypedDict, closed=True):
    login_path: NotRequired["capo_wafv2.types.login_path_string.LoginPathString"]
    """<note> <p>Instead of this setting, provide your configuration under <code>AWSManagedRulesATPRuleSet</code>. </p> </note>"""
    payload_type: NotRequired["capo_wafv2.types.payload_type.PayloadType"]
    """<note> <p>Instead of this setting, provide your configuration under the request inspection configuration for <code>AWSManagedRulesATPRuleSet</code> or <code>AWSManagedRulesACFPRuleSet</code>. </p> </note>"""
    username_field: NotRequired["capo_wafv2.types.username_field.UsernameField"]
    """<note> <p>Instead of this setting, provide your configuration under the request inspection configuration for <code>AWSManagedRulesATPRuleSet</code> or <code>AWSManagedRulesACFPRuleSet</code>. </p> </note>"""
    password_field: NotRequired["capo_wafv2.types.password_field.PasswordField"]
    """<note> <p>Instead of this setting, provide your configuration under the request inspection configuration for <code>AWSManagedRulesATPRuleSet</code> or <code>AWSManagedRulesACFPRuleSet</code>. </p> </note>"""
    aws_managed_rules_bot_control_rule_set: NotRequired[
        "capo_wafv2.types.aws_managed_rules_bot_control_rule_set.AWSManagedRulesBotControlRuleSet"
    ]
    """<p>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 <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html">WAF Bot Control rule group</a> and <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html">WAF Bot Control</a> in the <i>WAF Developer Guide</i>.</p>"""
    aws_managed_rules_atp_rule_set: NotRequired[
        "capo_wafv2.types.aws_managed_rules_atp_rule_set.AWSManagedRulesATPRuleSet"
    ]
    """<p>Additional configuration for using the account takeover prevention (ATP) managed rule group, <code>AWSManagedRulesATPRuleSet</code>. 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. </p> <p>This configuration replaces the individual configuration fields in <code>ManagedRuleGroupConfig</code> and provides additional feature configuration. </p> <p>For information about using the ATP managed rule group, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html">WAF Fraud Control account takeover prevention (ATP) rule group</a> and <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html">WAF Fraud Control account takeover prevention (ATP)</a> in the <i>WAF Developer Guide</i>.</p>"""
    aws_managed_rules_acfp_rule_set: NotRequired[
        "capo_wafv2.types.aws_managed_rules_acfp_rule_set.AWSManagedRulesACFPRuleSet"
    ]
    """<p>Additional configuration for using the account creation fraud prevention (ACFP) managed rule group, <code>AWSManagedRulesACFPRuleSet</code>. 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. </p> <p>For information about using the ACFP managed rule group, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html">WAF Fraud Control account creation fraud prevention (ACFP) rule group</a> and <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html">WAF Fraud Control account creation fraud prevention (ACFP)</a> in the <i>WAF Developer Guide</i>.</p>"""
    aws_managed_rules_anti_d_do_s_rule_set: NotRequired[
        "capo_wafv2.types.aws_managed_rules_anti_d_do_s_rule_set.AWSManagedRulesAntiDDoSRuleSet"
    ]
    """<p>Additional configuration for using the anti-DDoS managed rule group, <code>AWSManagedRulesAntiDDoSRuleSet</code>. Use this to configure anti-DDoS behavior for the rule group. </p> <p>For information about using the anti-DDoS managed rule group, see <a href="https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-anti-ddos.html">WAF Anti-DDoS rule group</a> and <a href="https://docs.aws.amazon.com/waf/latest/developerguide/waf-anti-ddos.html">Distributed Denial of Service (DDoS) prevention</a> in the <i>WAF Developer Guide</i>.</p>"""

aws_managed_rules_acfp_rule_set instance-attribute

aws_managed_rules_acfp_rule_set: NotRequired[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.

aws_managed_rules_anti_d_do_s_rule_set instance-attribute

aws_managed_rules_anti_d_do_s_rule_set: NotRequired[AWSManagedRulesAntiDDoSRuleSet]

Additional configuration for using the anti-DDoS managed rule group, AWSManagedRulesAntiDDoSRuleSet. Use this to configure anti-DDoS behavior for the rule group.

For information about using the anti-DDoS managed rule group, see WAF Anti-DDoS rule group and Distributed Denial of Service (DDoS) prevention in the WAF Developer Guide.

aws_managed_rules_atp_rule_set instance-attribute

aws_managed_rules_atp_rule_set: NotRequired[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) in the WAF Developer Guide.

aws_managed_rules_bot_control_rule_set instance-attribute

aws_managed_rules_bot_control_rule_set: NotRequired[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.

login_path instance-attribute

login_path: NotRequired[LoginPathString]

Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet.

password_field instance-attribute

password_field: NotRequired[PasswordField]

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

payload_type instance-attribute

payload_type: NotRequired[PayloadType]

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.

username_field instance-attribute

username_field: NotRequired[UsernameField]

Instead of this setting, provide your configuration under the request inspection configuration for AWSManagedRulesATPRuleSet or AWSManagedRulesACFPRuleSet.