software.amazon.awscdk.services.wafv2

Class CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder

java.lang.Object

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

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnWebACL.IPSetForwardedIPConfigurationProperty>

Enclosing interface:

CfnWebACL.IPSetForwardedIPConfigurationProperty

@Stability(value=Stable)
public static final class CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder
extends Object
implements software.amazon.jsii.Builder<CfnWebACL.IPSetForwardedIPConfigurationProperty>

A builder for CfnWebACL.IPSetForwardedIPConfigurationProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnWebACL.IPSetForwardedIPConfigurationProperty	build() Builds the configured instance.
CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder	fallbackBehavior(String fallbackBehavior) Sets the value of CfnWebACL.IPSetForwardedIPConfigurationProperty.getFallbackBehavior()
CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder	headerName(String headerName) Sets the value of CfnWebACL.IPSetForwardedIPConfigurationProperty.getHeaderName()
CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder	position(String position) Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder fallbackBehavior(String fallbackBehavior)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder headerName(String headerName)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.IPSetForwardedIPConfigurationProperty.Builder position(String position)

Sets the value of CfnWebACL.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

@Stability(value=Stable)
public CfnWebACL.IPSetForwardedIPConfigurationProperty build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnWebACL.IPSetForwardedIPConfigurationProperty>

Returns:

a new instance of CfnWebACL.IPSetForwardedIPConfigurationProperty

Throws:

NullPointerException - if any required attribute was not provided