Package software.amazon.awscdk.services.wafv2

Interface CfnRuleGroup.IPSetReferenceStatementProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.IPSetReferenceStatementProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.IPSetReferenceStatementProperty
extends software.amazon.jsii.JsiiSerializable

A rule statement used to detect web requests coming from particular IP addresses or address ranges.

To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement.

Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

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.*;
 IPSetReferenceStatementProperty iPSetReferenceStatementProperty = Map.of(
         "arn", "arn",
         // the properties below are optional
         "ipSetForwardedIpConfig", Map.of(
                 "fallbackBehavior", "fallbackBehavior",
                 "headerName", "headerName",
                 "position", "position"));
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.IPSetReferenceStatementProperty.Builder	builder()
String	getArn()	The Amazon Resource Name (ARN) of the IPSet that this statement references.
default Object	getIpSetForwardedIpConfig()	The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getArn

@Stability(Stable)
@NotNull
String getArn()

The Amazon Resource Name (ARN) of the IPSet that this statement references.

getIpSetForwardedIpConfig

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

The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin.

Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.

If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

builder

@Stability(Stable)
static CfnRuleGroup.IPSetReferenceStatementProperty.Builder builder()

Returns:

a CfnRuleGroup.IPSetReferenceStatementProperty.Builder of CfnRuleGroup.IPSetReferenceStatementProperty