software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder

java.lang.Object

software.amazon.awscdk.services.wafv2.CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder

Enclosing interface:

CfnRuleGroup.IPSetForwardedIPConfigurationProperty

public static final class CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder
extends java.lang.Object

A builder for CfnRuleGroup.IPSetForwardedIPConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRuleGroup.IPSetForwardedIPConfigurationProperty	build() Builds the configured instance.
CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder	fallbackBehavior(java.lang.String fallbackBehavior) Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getFallbackBehavior()
CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder	headerName(java.lang.String headerName) Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getHeaderName()
CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder	position(java.lang.String position) Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getPosition()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

fallbackBehavior

public CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder fallbackBehavior(java.lang.String fallbackBehavior)

Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getFallbackBehavior()

Parameters:

fallbackBehavior - The match status to assign to the web request if the request doesn't have a valid IP address in the specified position. This parameter is required.

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

You can specify the following fallback behaviors:

• MATCH - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
• NO_MATCH - Treat the web request as not matching the rule statement.

Returns:

this

headerName

public CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder headerName(java.lang.String headerName)

Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getHeaderName()

Parameters:

headerName - The name of the HTTP header to use for the IP address. This parameter is required. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For .

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

Returns:

this

position

public CfnRuleGroup.IPSetForwardedIPConfigurationProperty.Builder position(java.lang.String position)

Sets the value of CfnRuleGroup.IPSetForwardedIPConfigurationProperty.getPosition()

Parameters:

position - The position in the header to search for the IP address. This parameter is required. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

The options for this setting are the following:

• FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
• LAST - Inspect the last IP address in the list of IP addresses in the header.
• ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

Returns:

this

build

public CfnRuleGroup.IPSetForwardedIPConfigurationProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRuleGroup.IPSetForwardedIPConfigurationProperty

Throws:

java.lang.NullPointerException - if any required attribute was not provided