Package com.pulumi.cloudflare.inputs

Class RulesetRuleRatelimitArgs

java.lang.Object

com.pulumi.resources.InputArgs

com.pulumi.resources.ResourceArgs

com.pulumi.cloudflare.inputs.RulesetRuleRatelimitArgs

public final class RulesetRuleRatelimitArgs
extends com.pulumi.resources.ResourceArgs

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RulesetRuleRatelimitArgs.Builder

Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

com.pulumi.resources.InputArgs.InputArgsInternal

Field Summary

Fields

Modifier and Type	Field	Description
static RulesetRuleRatelimitArgs	Empty

Method Summary

Modifier and Type	Method	Description
static RulesetRuleRatelimitArgs.Builder	builder()
static RulesetRuleRatelimitArgs.Builder	builder(RulesetRuleRatelimitArgs defaults)
java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>>	characteristics()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	countingExpression()
java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>	mitigationTimeout()
java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>	period()
java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>	requestsPerPeriod()
java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>>	requestsToOrigin()
java.util.Optional<com.pulumi.core.Output<java.lang.Integer>>	scorePerPeriod()
java.util.Optional<com.pulumi.core.Output<java.lang.String>>	scoreResponseHeaderName()

Methods inherited from class com.pulumi.resources.ResourceArgs

validateMember

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

Empty

public static final RulesetRuleRatelimitArgs Empty

Method Detail

characteristics

public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> characteristics()

Returns:

List of parameters that define how Cloudflare tracks the request rate for this rule.

countingExpression

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> countingExpression()

Returns:

Criteria for counting HTTP requests to trigger the Rate Limiting action. Uses the Firewall Rules expression language based on Wireshark display filters. Refer to the [Firewall Rules language](https://developers.cloudflare.com/firewall/cf-firewall-language) documentation for all available fields, operators, and functions.

mitigationTimeout

public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> mitigationTimeout()

Returns:

Once the request rate is reached, the Rate Limiting rule blocks further requests for the period of time defined in this field.

period

public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> period()

Returns:

The period of time to consider (in seconds) when evaluating the request rate.

requestsPerPeriod

public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> requestsPerPeriod()

Returns:

The number of requests over the period of time that will trigger the Rate Limiting rule.

requestsToOrigin

public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> requestsToOrigin()

Returns:

Whether to include requests to origin within the Rate Limiting count.

scorePerPeriod

public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> scorePerPeriod()

Returns:

The maximum aggregate score over the period of time that will trigger Rate Limiting rule.

scoreResponseHeaderName

public java.util.Optional<com.pulumi.core.Output<java.lang.String>> scoreResponseHeaderName()

Returns:

Name of HTTP header in the response, set by the origin server, with the score for the current request.

builder

public static RulesetRuleRatelimitArgs.Builder builder()

builder

public static RulesetRuleRatelimitArgs.Builder builder(RulesetRuleRatelimitArgs defaults)