Package software.amazon.awscdk.services.wafv2

Interface CfnWebACL.ResponseInspectionHeaderProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnWebACL.ResponseInspectionHeaderProperty.Jsii$Proxy

Enclosing class:

CfnWebACL

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

Configures inspection of the response header. 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.*;
 ResponseInspectionHeaderProperty responseInspectionHeaderProperty = ResponseInspectionHeaderProperty.builder()
         .failureValues(List.of("failureValues"))
         .name("name")
         .successValues(List.of("successValues"))
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnWebACL.ResponseInspectionHeaderProperty.Builder	builder()
List<String>	getFailureValues()	Values in the response header with the specified name that indicate a failed login or account creation attempt.
String	getName()	The name of the header to match against.
List<String>	getSuccessValues()	Values in the response header with the specified name 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 in the response header with the specified name 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 examples: "FailureValues": [ "LoginFailed", "Failed login" ] and "FailureValues": [ "AccountCreationFailed" ]

getName

@Stability(Stable)
@NotNull
String getName()

The name of the header to match against. The name must be an exact match, including case.

JSON example: "Name": [ "RequestResult" ]

getSuccessValues

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

Values in the response header with the specified name 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 examples: "SuccessValues": [ "LoginPassed", "Successful login" ] and "SuccessValues": [ "AccountCreated", "Successful account creation" ]

builder

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

Returns:

a CfnWebACL.ResponseInspectionHeaderProperty.Builder of CfnWebACL.ResponseInspectionHeaderProperty