Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.AWSManagedRulesATPRuleSetProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnWebACL.AWSManagedRulesATPRuleSetProperty.Jsii$Proxy
Enclosing class:
CfnWebACL
@Stability(Stable) public static interface CfnWebACL.AWSManagedRulesATPRuleSetProperty extends software.amazon.jsii.JsiiSerializable
Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet .

This configuration is used in ManagedRuleGroupConfig .

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.*;
 AWSManagedRulesATPRuleSetProperty aWSManagedRulesATPRuleSetProperty = 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();

  • Method Details

    • getLoginPath

      @Stability(Stable) @NotNull String getLoginPath()
      The path of the login endpoint for your application.

      For example, for the URL https://example.com/web/login , you would provide the path /web/login .

      The rule group inspects only HTTP POST requests to your specified login endpoint.

    • getRequestInspection

      @Stability(Stable) @Nullable default Object getRequestInspection()
      The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.

    • getResponseInspection

      @Stability(Stable) @Nullable default Object getResponseInspection()
      The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.

      Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

      The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.

    • builder

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