interface IPSetReferenceStatementProperty

Language	Type name
.NET	`Amazon.CDK.AWS.WAFv2.CfnRuleGroup.IPSetReferenceStatementProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awswafv2#CfnRuleGroup_IPSetReferenceStatementProperty`
Java	`software.amazon.awscdk.services.wafv2.CfnRuleGroup.IPSetReferenceStatementProperty`
Python	`aws_cdk.aws_wafv2.CfnRuleGroup.IPSetReferenceStatementProperty`
TypeScript	`aws-cdk-lib` » `aws_wafv2` » `CfnRuleGroup` » `IPSetReferenceStatementProperty`

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 { aws_wafv2 as wafv2 } from 'aws-cdk-lib';
const iPSetReferenceStatementProperty: wafv2.CfnRuleGroup.IPSetReferenceStatementProperty = {
  arn: 'arn',

  // the properties below are optional
  ipSetForwardedIpConfig: {
    fallbackBehavior: 'fallbackBehavior',
    headerName: 'headerName',
    position: 'position',
  },
};

Properties

Name	Type	Description
arn	`string`	The Amazon Resource Name (ARN) of the `IPSet` that this statement references.
ipSetForwardedIpConfig?	`IResolvable` `\|` `IPSetForwardedIPConfigurationProperty`	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.

arn

Type: string

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

ipSetForwardedIpConfig?

Type: IResolvable | IPSetForwardedIPConfigurationProperty (optional)

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.