Interface GeoMatchStatement.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<GeoMatchStatement.Builder,GeoMatchStatement>,SdkBuilder<GeoMatchStatement.Builder,GeoMatchStatement>,SdkPojo
- Enclosing class:
- GeoMatchStatement
public static interface GeoMatchStatement.Builder extends SdkPojo, CopyableBuilder<GeoMatchStatement.Builder,GeoMatchStatement>
-
-
Method Summary
All Methods Instance Methods Abstract Methods Default Methods Modifier and Type Method Description GeoMatchStatement.BuildercountryCodes(Collection<CountryCode> countryCodes)An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.GeoMatchStatement.BuildercountryCodes(CountryCode... countryCodes)An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.GeoMatchStatement.BuildercountryCodesWithStrings(String... countryCodes)An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.GeoMatchStatement.BuildercountryCodesWithStrings(Collection<String> countryCodes)An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.default GeoMatchStatement.BuilderforwardedIPConfig(Consumer<ForwardedIPConfig.Builder> forwardedIPConfig)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.GeoMatchStatement.BuilderforwardedIPConfig(ForwardedIPConfig forwardedIPConfig)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.-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
countryCodesWithStrings
GeoMatchStatement.Builder countryCodesWithStrings(Collection<String> countryCodes)
An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Parameters:
countryCodes- An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
countryCodesWithStrings
GeoMatchStatement.Builder countryCodesWithStrings(String... countryCodes)
An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Parameters:
countryCodes- An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
countryCodes
GeoMatchStatement.Builder countryCodes(Collection<CountryCode> countryCodes)
An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Parameters:
countryCodes- An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
countryCodes
GeoMatchStatement.Builder countryCodes(CountryCode... countryCodes)
An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Parameters:
countryCodes- An array of two-character country codes that you want to match against, for example,[ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forwardedIPConfig
GeoMatchStatement.Builder forwardedIPConfig(ForwardedIPConfig forwardedIPConfig)
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.
- Parameters:
forwardedIPConfig- 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.
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
forwardedIPConfig
default GeoMatchStatement.Builder forwardedIPConfig(Consumer<ForwardedIPConfig.Builder> forwardedIPConfig)
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.
This is a convenience method that creates an instance of theIf the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
ForwardedIPConfig.Builderavoiding the need to create one manually viaForwardedIPConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toforwardedIPConfig(ForwardedIPConfig).- Parameters:
forwardedIPConfig- a consumer that will call methods onForwardedIPConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
forwardedIPConfig(ForwardedIPConfig)
-
-