software.amazon.awscdk.services.wafv2

Class CfnRuleGroup.RateBasedStatementProperty.Builder

java.lang.Object

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

Enclosing interface:

CfnRuleGroup.RateBasedStatementProperty

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

A builder for CfnRuleGroup.RateBasedStatementProperty

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
CfnRuleGroup.RateBasedStatementProperty.Builder	aggregateKeyType(java.lang.String aggregateKeyType) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getAggregateKeyType()
CfnRuleGroup.RateBasedStatementProperty	build() Builds the configured instance.
CfnRuleGroup.RateBasedStatementProperty.Builder	forwardedIpConfig(CfnRuleGroup.ForwardedIPConfigurationProperty forwardedIpConfig) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getForwardedIpConfig()
CfnRuleGroup.RateBasedStatementProperty.Builder	forwardedIpConfig(IResolvable forwardedIpConfig) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getForwardedIpConfig()
CfnRuleGroup.RateBasedStatementProperty.Builder	limit(java.lang.Number limit) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getLimit()
CfnRuleGroup.RateBasedStatementProperty.Builder	scopeDownStatement(CfnRuleGroup.StatementProperty scopeDownStatement) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getScopeDownStatement()
CfnRuleGroup.RateBasedStatementProperty.Builder	scopeDownStatement(IResolvable scopeDownStatement) Sets the value of CfnRuleGroup.RateBasedStatementProperty.getScopeDownStatement()

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

aggregateKeyType

public CfnRuleGroup.RateBasedStatementProperty.Builder aggregateKeyType(java.lang.String aggregateKeyType)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getAggregateKeyType()

Parameters:

aggregateKeyType - Setting that indicates how to aggregate the request counts. The options are the following:. This parameter is required.

• 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.

Returns:

this

limit

public CfnRuleGroup.RateBasedStatementProperty.Builder limit(java.lang.Number limit)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getLimit()

Parameters:

limit - The limit on requests per 5-minute period for a single originating IP address. This parameter is required. If the statement includes a ScopeDownStatement , this limit is applied only to the requests that match the statement.

Returns:

this

forwardedIpConfig

public CfnRuleGroup.RateBasedStatementProperty.Builder forwardedIpConfig(IResolvable forwardedIpConfig)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getForwardedIpConfig()

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, AWS WAF doesn't apply the rule to the web request at all.

This is required if AggregateKeyType is set to FORWARDED_IP .

Returns:

this

forwardedIpConfig

public CfnRuleGroup.RateBasedStatementProperty.Builder forwardedIpConfig(CfnRuleGroup.ForwardedIPConfigurationProperty forwardedIpConfig)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getForwardedIpConfig()

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, AWS WAF doesn't apply the rule to the web request at all.

This is required if AggregateKeyType is set to FORWARDED_IP .

Returns:

this

scopeDownStatement

public CfnRuleGroup.RateBasedStatementProperty.Builder scopeDownStatement(IResolvable scopeDownStatement)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getScopeDownStatement()

Parameters:

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.

Returns:

this

scopeDownStatement

public CfnRuleGroup.RateBasedStatementProperty.Builder scopeDownStatement(CfnRuleGroup.StatementProperty scopeDownStatement)

Sets the value of CfnRuleGroup.RateBasedStatementProperty.getScopeDownStatement()

Parameters:

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.

Returns:

this

build

public CfnRuleGroup.RateBasedStatementProperty build()

Builds the configured instance.

Returns:

a new instance of CfnRuleGroup.RateBasedStatementProperty

Throws:

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