Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ManagedRuleGroupConfigProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWebACL.ManagedRuleGroupConfigProperty.Jsii$Proxy
Enclosing class:
CfnWebACL
@Stability(Stable) public static interface CfnWebACL.ManagedRuleGroupConfigProperty extends software.amazon.jsii.JsiiSerializable
Additional information that's used by a managed rule group. Many managed rule groups don't require this.

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

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.wafv2.*;
 ManagedRuleGroupConfigProperty managedRuleGroupConfigProperty = ManagedRuleGroupConfigProperty.builder()
         .awsManagedRulesAtpRuleSet(AWSManagedRulesATPRuleSetProperty.builder()
                 .loginPath("loginPath")
                 // the properties below are optional
                 .requestInspection(RequestInspectionProperty.builder()
                         .passwordField(FieldIdentifierProperty.builder()
                                 .identifier("identifier")
                                 .build())
                         .payloadType("payloadType")
                         .usernameField(FieldIdentifierProperty.builder()
                                 .identifier("identifier")
                                 .build())
                         .build())
                 .responseInspection(ResponseInspectionProperty.builder()
                         .bodyContains(ResponseInspectionBodyContainsProperty.builder()
                                 .failureStrings(List.of("failureStrings"))
                                 .successStrings(List.of("successStrings"))
                                 .build())
                         .header(ResponseInspectionHeaderProperty.builder()
                                 .failureValues(List.of("failureValues"))
                                 .name("name")
                                 .successValues(List.of("successValues"))
                                 .build())
                         .json(ResponseInspectionJsonProperty.builder()
                                 .failureValues(List.of("failureValues"))
                                 .identifier("identifier")
                                 .successValues(List.of("successValues"))
                                 .build())
                         .statusCode(ResponseInspectionStatusCodeProperty.builder()
                                 .failureCodes(List.of(123))
                                 .successCodes(List.of(123))
                                 .build())
                         .build())
                 .build())
         .awsManagedRulesBotControlRuleSet(AWSManagedRulesBotControlRuleSetProperty.builder()
                 .inspectionLevel("inspectionLevel")
                 .build())
         .loginPath("loginPath")
         .passwordField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .payloadType("payloadType")
         .usernameField(FieldIdentifierProperty.builder()
                 .identifier("identifier")
                 .build())
         .build();

  • Method Details

    • getAwsManagedRulesAtpRuleSet

      @Stability(Stable) @Nullable default Object getAwsManagedRulesAtpRuleSet()
      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 AWS WAF Fraud Control account takeover prevention (ATP) rule group and AWS WAF Fraud Control account takeover prevention (ATP) in the AWS WAF Developer Guide .

    • getAwsManagedRulesBotControlRuleSet

      @Stability(Stable) @Nullable default Object getAwsManagedRulesBotControlRuleSet()
      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 AWS WAF Bot Control rule group and AWS WAF Bot Control in the AWS WAF Developer Guide .

    • getLoginPath

      @Stability(Stable) @Nullable default String getLoginPath()

      Instead of this setting, provide your configuration under AWSManagedRulesATPRuleSet .

    • getPasswordField

      @Stability(Stable) @Nullable default Object getPasswordField()

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

    • getPayloadType

      @Stability(Stable) @Nullable default String getPayloadType()

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

    • getUsernameField

      @Stability(Stable) @Nullable default Object getUsernameField()

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

    • builder

      @Stability(Stable) static CfnWebACL.ManagedRuleGroupConfigProperty.Builder builder()
      Returns:
      a CfnWebACL.ManagedRuleGroupConfigProperty.Builder of CfnWebACL.ManagedRuleGroupConfigProperty