# 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.

- Source: Generated at build time
- Type last changed: v2.93.0 · 23 Aug 2023

## Example

TypeScript:

```ts
// 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',
  },
};
```

Python:

```python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_wafv2 as wafv2

i_p_set_reference_statement_property = {
    "arn": "arn",

    # the properties below are optional
    "ip_set_forwarded_ip_config": {
        "fallback_behavior": "fallbackBehavior",
        "header_name": "headerName",
        "position": "position"
    }
}
```

Java:

```java
// 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"));
```

C# / .NET:

```csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WAFv2;

var iPSetReferenceStatementProperty = new Dictionary<string, object> {
    { "arn", "arn" },

    // the properties below are optional
    { "ipSetForwardedIpConfig", new Dictionary<string, string> {
        { "fallbackBehavior", "fallbackBehavior" },
        { "headerName", "headerName" },
        { "position", "position" }
    } }
};
```

Golang:

```go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

iPSetReferenceStatementProperty := map[string]interface{}{
	"arn": jsii.String("arn"),

	// the properties below are optional
	"ipSetForwardedIpConfig": map[string]*string{
		"fallbackBehavior": jsii.String("fallbackBehavior"),
		"headerName": jsii.String("headerName"),
		"position": jsii.String("position"),
	},
}
```

## Properties

- `arn`: string (required) — The Amazon Resource Name (ARN) of the `IPSet` that this statement references.

- `ipSetForwardedIpConfig`: [IResolvable](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.IResolvable.html) | [CfnRuleGroup.IPSetForwardedIPConfigurationProperty](https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_wafv2.CfnRuleGroup.IPSetForwardedIPConfigurationProperty.html) — 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.
