public static interface RateBasedStatement.Builder extends SdkPojo, CopyableBuilder<RateBasedStatement.Builder,RateBasedStatement>
| Modifier and Type | Method and Description |
|---|---|
RateBasedStatement.Builder |
aggregateKeyType(RateBasedStatementAggregateKeyType aggregateKeyType)
Setting that indicates how to aggregate the request counts.
|
RateBasedStatement.Builder |
aggregateKeyType(String aggregateKeyType)
Setting that indicates how to aggregate the request counts.
|
default RateBasedStatement.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.
|
RateBasedStatement.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.
|
RateBasedStatement.Builder |
limit(Long limit)
The limit on requests per 5-minute period for a single originating IP address.
|
default RateBasedStatement.Builder |
scopeDownStatement(Consumer<Statement.Builder> scopeDownStatement)
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based
statement.
|
RateBasedStatement.Builder |
scopeDownStatement(Statement scopeDownStatement)
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based
statement.
|
equalsBySdkFields, sdkFieldscopyapplyMutation, buildRateBasedStatement.Builder limit(Long limit)
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a
ScopeDownStatement, this limit is applied only to the requests that match the statement.
limit - The limit on requests per 5-minute period for a single originating IP address. If the statement
includes a ScopeDownStatement, this limit is applied only to the requests that match the
statement.RateBasedStatement.Builder aggregateKeyType(String aggregateKeyType)
Setting that indicates how to aggregate the request counts. The options are the following:
IP - Aggregate the request counts on the IP address from the web request origin.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this,
configure the ForwardedIPConfig, to specify the header to use.
aggregateKeyType - Setting that indicates how to aggregate the request counts. The options are the following:
IP - Aggregate the request counts on the IP address from the web request origin.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use
this, configure the ForwardedIPConfig, to specify the header to use.
RateBasedStatementAggregateKeyType,
RateBasedStatementAggregateKeyTypeRateBasedStatement.Builder aggregateKeyType(RateBasedStatementAggregateKeyType aggregateKeyType)
Setting that indicates how to aggregate the request counts. The options are the following:
IP - Aggregate the request counts on the IP address from the web request origin.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this,
configure the ForwardedIPConfig, to specify the header to use.
aggregateKeyType - Setting that indicates how to aggregate the request counts. The options are the following:
IP - Aggregate the request counts on the IP address from the web request origin.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use
this, configure the ForwardedIPConfig, to specify the header to use.
RateBasedStatementAggregateKeyType,
RateBasedStatementAggregateKeyTypeRateBasedStatement.Builder scopeDownStatement(Statement scopeDownStatement)
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
scopeDownStatement - An optional nested statement that narrows the scope of the web requests that are evaluated by the
rate-based statement. Requests are only tracked by the rate-based statement if they match the
scope-down statement. You can use any nestable Statement in the scope-down statement, and you
can nest statements at any level, the same as you can for a rule statement.default RateBasedStatement.Builder scopeDownStatement(Consumer<Statement.Builder> scopeDownStatement)
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
This is a convenience method that creates an instance of theStatement.Builder avoiding the need to
create one manually via Statement.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its result
is passed to scopeDownStatement(Statement).
scopeDownStatement - a consumer that will call methods on Statement.BuilderscopeDownStatement(Statement)RateBasedStatement.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.
This is required if AggregateKeyType is set to FORWARDED_IP.
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.
This is required if AggregateKeyType is set to FORWARDED_IP.
default RateBasedStatement.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.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This is required if AggregateKeyType is set to FORWARDED_IP.
ForwardedIPConfig.Builder avoiding the
need to create one manually via ForwardedIPConfig.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and its
result is passed to forwardedIPConfig(ForwardedIPConfig).
forwardedIPConfig - a consumer that will call methods on ForwardedIPConfig.BuilderforwardedIPConfig(ForwardedIPConfig)Copyright © 2022. All rights reserved.