Package software.amazon.awssdk.services.waf.model

Class CreateRateBasedRuleRequest

java.lang.Object

software.amazon.awssdk.AmazonWebServiceRequest

software.amazon.awssdk.services.waf.model.CreateRateBasedRuleRequest

All Implemented Interfaces:

Cloneable, ReadLimitInfo, ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>

@Generated("software.amazon.awssdk:codegen")
public class CreateRateBasedRuleRequest
extends AmazonWebServiceRequest
implements ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CreateRateBasedRuleRequest.Builder

Field Summary

Fields inherited from class software.amazon.awssdk.AmazonWebServiceRequest

NOOP

Method Summary

Modifier and Type	Method	Description
static CreateRateBasedRuleRequest.Builder	builder()
String	changeToken()	The ChangeToken that you used to submit the CreateRateBasedRule request.
boolean	equals(Object obj)
int	hashCode()
String	metricName()	A friendly name or description for the metrics for this RateBasedRule.
String	name()	A friendly name or description of the RateBasedRule.
String	rateKey()	The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring.
Long	rateLimit()	The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period.
static Class<? extends CreateRateBasedRuleRequest.Builder>	serializableBuilderClass()
CreateRateBasedRuleRequest.Builder	toBuilder()	Take this object and create a builder that contains all of the current property values of this object.
String	toString()

Methods inherited from class software.amazon.awssdk.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getReadLimit, getRequestClientOptions, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, withGeneralProgressListener, withRequestMetricCollector, withSdkClientExecutionTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

name

public String name()

A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

Returns:

A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

metricName

public String metricName()

A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

Returns:

A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

rateKey

public String rateKey()

The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

Returns:

The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

See Also:

RateKey

rateLimit

public Long rateLimit()

The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Returns:

The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

changeToken

public String changeToken()

The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

toBuilder

public CreateRateBasedRuleRequest.Builder toBuilder()

Description copied from interface: ToCopyableBuilder

Take this object and create a builder that contains all of the current property values of this object.

Specified by:

toBuilder in interface ToCopyableBuilder<CreateRateBasedRuleRequest.Builder,CreateRateBasedRuleRequest>

Returns:

a builder for type T

builder

public static CreateRateBasedRuleRequest.Builder builder()

serializableBuilderClass

public static Class<? extends CreateRateBasedRuleRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object