com.amazonaws.services.wafv2.model.IPSetForwardedIPConfig Maven / Gradle / Ivy
Show all versions of aws-java-sdk-wafv2 Show documentation
/*
* Copyright 2019-2024 Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package com.amazonaws.services.wafv2.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* 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, WAF doesn't apply the rule to the web request at all.
*
*
*
* This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and
* RateBasedStatement, use ForwardedIPConfig instead.
*
*
* @see AWS API
* Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class IPSetForwardedIPConfig implements Serializable, Cloneable, StructuredPojo {
/**
*
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at all.
*
*
*/
private String headerName;
/**
*
* The match status to assign to the web request if the request doesn't have a valid IP address in the specified
* position.
*
*
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to the
* request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
*
*/
private String fallbackBehavior;
/**
*
* The position in the header to search for the IP address. 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, WAF
* inspects the last 10.
*
*
*
*/
private String position;
/**
*
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at all.
*
*
*
* @param headerName
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at
* all.
*
*/
public void setHeaderName(String headerName) {
this.headerName = headerName;
}
/**
*
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at all.
*
*
*
* @return The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at
* all.
*
*/
public String getHeaderName() {
return this.headerName;
}
/**
*
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at all.
*
*
*
* @param headerName
* The name of the HTTP header to use for the IP address. 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, WAF doesn't apply the rule to the web request at
* all.
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
public IPSetForwardedIPConfig withHeaderName(String headerName) {
setHeaderName(headerName);
return this;
}
/**
*
* The match status to assign to the web request if the request doesn't have a valid IP address in the specified
* position.
*
*
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to the
* request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
*
*
* @param fallbackBehavior
* The match status to assign to the web request if the request doesn't have a valid IP address in the
* specified position.
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to
* the request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
* @see FallbackBehavior
*/
public void setFallbackBehavior(String fallbackBehavior) {
this.fallbackBehavior = fallbackBehavior;
}
/**
*
* The match status to assign to the web request if the request doesn't have a valid IP address in the specified
* position.
*
*
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to the
* request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
*
*
* @return The match status to assign to the web request if the request doesn't have a valid IP address in the
* specified position.
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to
* the request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
* @see FallbackBehavior
*/
public String getFallbackBehavior() {
return this.fallbackBehavior;
}
/**
*
* The match status to assign to the web request if the request doesn't have a valid IP address in the specified
* position.
*
*
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to the
* request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
*
*
* @param fallbackBehavior
* The match status to assign to the web request if the request doesn't have a valid IP address in the
* specified position.
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to
* the request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FallbackBehavior
*/
public IPSetForwardedIPConfig withFallbackBehavior(String fallbackBehavior) {
setFallbackBehavior(fallbackBehavior);
return this;
}
/**
*
* The match status to assign to the web request if the request doesn't have a valid IP address in the specified
* position.
*
*
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to the
* request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
*
*
* @param fallbackBehavior
* The match status to assign to the web request if the request doesn't have a valid IP address in the
* specified position.
*
* If the specified header isn't present in the request, 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. WAF applies the rule action to
* the request.
*
*
* -
*
* NO_MATCH - Treat the web request as not matching the rule statement.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see FallbackBehavior
*/
public IPSetForwardedIPConfig withFallbackBehavior(FallbackBehavior fallbackBehavior) {
this.fallbackBehavior = fallbackBehavior.toString();
return this;
}
/**
*
* The position in the header to search for the IP address. 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, WAF
* inspects the last 10.
*
*
*
*
* @param position
* The position in the header to search for the IP address. 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, WAF inspects the last 10.
*
*
* @see ForwardedIPPosition
*/
public void setPosition(String position) {
this.position = position;
}
/**
*
* The position in the header to search for the IP address. 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, WAF
* inspects the last 10.
*
*
*
*
* @return The position in the header to search for the IP address. 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, WAF inspects the last 10.
*
*
* @see ForwardedIPPosition
*/
public String getPosition() {
return this.position;
}
/**
*
* The position in the header to search for the IP address. 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, WAF
* inspects the last 10.
*
*
*
*
* @param position
* The position in the header to search for the IP address. 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, WAF inspects the last 10.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ForwardedIPPosition
*/
public IPSetForwardedIPConfig withPosition(String position) {
setPosition(position);
return this;
}
/**
*
* The position in the header to search for the IP address. 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, WAF
* inspects the last 10.
*
*
*
*
* @param position
* The position in the header to search for the IP address. 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, WAF inspects the last 10.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
* @see ForwardedIPPosition
*/
public IPSetForwardedIPConfig withPosition(ForwardedIPPosition position) {
this.position = position.toString();
return this;
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*
* @return A string representation of this object.
*
* @see java.lang.Object#toString()
*/
@Override
public String toString() {
StringBuilder sb = new StringBuilder();
sb.append("{");
if (getHeaderName() != null)
sb.append("HeaderName: ").append(getHeaderName()).append(",");
if (getFallbackBehavior() != null)
sb.append("FallbackBehavior: ").append(getFallbackBehavior()).append(",");
if (getPosition() != null)
sb.append("Position: ").append(getPosition());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof IPSetForwardedIPConfig == false)
return false;
IPSetForwardedIPConfig other = (IPSetForwardedIPConfig) obj;
if (other.getHeaderName() == null ^ this.getHeaderName() == null)
return false;
if (other.getHeaderName() != null && other.getHeaderName().equals(this.getHeaderName()) == false)
return false;
if (other.getFallbackBehavior() == null ^ this.getFallbackBehavior() == null)
return false;
if (other.getFallbackBehavior() != null && other.getFallbackBehavior().equals(this.getFallbackBehavior()) == false)
return false;
if (other.getPosition() == null ^ this.getPosition() == null)
return false;
if (other.getPosition() != null && other.getPosition().equals(this.getPosition()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getHeaderName() == null) ? 0 : getHeaderName().hashCode());
hashCode = prime * hashCode + ((getFallbackBehavior() == null) ? 0 : getFallbackBehavior().hashCode());
hashCode = prime * hashCode + ((getPosition() == null) ? 0 : getPosition().hashCode());
return hashCode;
}
@Override
public IPSetForwardedIPConfig clone() {
try {
return (IPSetForwardedIPConfig) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.wafv2.model.transform.IPSetForwardedIPConfigMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}