Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ResponseInspectionJsonProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.ResponseInspectionJsonProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

@Stability(Stable)
public static interface CfnWebACL.ResponseInspectionJsonProperty
extends software.amazon.jsii.JsiiSerializable

Configures inspection of the response JSON.

AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection configuration for AWSManagedRulesATPRuleSet and AWSManagedRulesACFPRuleSet .

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

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.*;
 ResponseInspectionJsonProperty responseInspectionJsonProperty = ResponseInspectionJsonProperty.builder()
         .failureValues(List.of("failureValues"))
         .identifier("identifier")
         .successValues(List.of("successValues"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnWebACL.ResponseInspectionJsonProperty.Builder	A builder for CfnWebACL.ResponseInspectionJsonProperty
static final class	CfnWebACL.ResponseInspectionJsonProperty.Jsii$Proxy	An implementation for CfnWebACL.ResponseInspectionJsonProperty

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.ResponseInspectionJsonProperty.Builder	builder()
List<String>	getFailureValues()	Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt.
String	getIdentifier()	The identifier for the value to match against in the JSON.
List<String>	getSuccessValues()	Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFailureValues

@Stability(Stable)
@NotNull
List<String> getFailureValues()

Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt.

To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "FailureValues": [ "False", "Failed" ]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-failurevalues

getIdentifier

@Stability(Stable)
@NotNull
String getIdentifier()

The identifier for the value to match against in the JSON.

The identifier must be an exact match, including case.

JSON examples: "Identifier": [ "/login/success" ] and "Identifier": [ "/sign-up/success" ]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-identifier

getSuccessValues

@Stability(Stable)
@NotNull
List<String> getSuccessValues()

Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt.

To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.

JSON example: "SuccessValues": [ "True", "Succeeded" ]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-webacl-responseinspectionjson.html#cfn-wafv2-webacl-responseinspectionjson-successvalues

builder

@Stability(Stable)
static CfnWebACL.ResponseInspectionJsonProperty.Builder builder()

Returns:

a CfnWebACL.ResponseInspectionJsonProperty.Builder of CfnWebACL.ResponseInspectionJsonProperty