com.amazonaws.services.waf.model

Class CreateRateBasedRuleRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.waf.model.CreateRateBasedRuleRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class CreateRateBasedRuleRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
CreateRateBasedRuleRequest()

Method Summary

Modifier and Type	Method and Description
CreateRateBasedRuleRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
String	getChangeToken() The ChangeToken that you used to submit the CreateRateBasedRule request.
String	getMetricName() A friendly name or description for the metrics for this RateBasedRule.
String	getName() A friendly name or description of the RateBasedRule.
String	getRateKey() The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring.
Long	getRateLimit() The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period.
List<Tag>	getTags()
int	hashCode()
void	setChangeToken(String changeToken) The ChangeToken that you used to submit the CreateRateBasedRule request.
void	setMetricName(String metricName) A friendly name or description for the metrics for this RateBasedRule.
void	setName(String name) A friendly name or description of the RateBasedRule.
void	setRateKey(RateKey rateKey) The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring.
void	setRateKey(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.
void	setRateLimit(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.
void	setTags(Collection<Tag> tags)
String	toString() Returns a string representation of this object.
CreateRateBasedRuleRequest	withChangeToken(String changeToken) The ChangeToken that you used to submit the CreateRateBasedRule request.
CreateRateBasedRuleRequest	withMetricName(String metricName) A friendly name or description for the metrics for this RateBasedRule.
CreateRateBasedRuleRequest	withName(String name) A friendly name or description of the RateBasedRule.
CreateRateBasedRuleRequest	withRateKey(RateKey rateKey) The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring.
CreateRateBasedRuleRequest	withRateKey(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.
CreateRateBasedRuleRequest	withRateLimit(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.
CreateRateBasedRuleRequest	withTags(Collection<Tag> tags)
CreateRateBasedRuleRequest	withTags(Tag... tags)

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateRateBasedRuleRequest

public CreateRateBasedRuleRequest()

Method Detail

setName

public void setName(String name)

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

Parameters:

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

getName

public String getName()

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.

withName

public CreateRateBasedRuleRequest withName(String name)

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

Parameters:

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

Returns:

Returns a reference to this object so that method calls can be chained together.

setMetricName

public void setMetricName(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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Parameters:

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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

getMetricName

public String getMetricName()

A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." 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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

withMetricName

public CreateRateBasedRuleRequest withMetricName(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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Parameters:

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), with maximum length 128 and minimum length one. It can't contain whitespace or metric names reserved for AWS WAF, including "All" and "Default_Action." You can't change the name of the metric after you create the RateBasedRule.

Returns:

Returns a reference to this object so that method calls can be chained together.

setRateKey

public void setRateKey(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.

Parameters:

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.

See Also:

RateKey

getRateKey

public String getRateKey()

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

withRateKey

public CreateRateBasedRuleRequest withRateKey(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

RateKey

setRateKey

public void setRateKey(RateKey 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.

Parameters:

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.

See Also:

RateKey

withRateKey

public CreateRateBasedRuleRequest withRateKey(RateKey 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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

See Also:

RateKey

setRateLimit

public void setRateLimit(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.

Parameters:

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.

getRateLimit

public Long getRateLimit()

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.

withRateLimit

public CreateRateBasedRuleRequest withRateLimit(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

setChangeToken

public void setChangeToken(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.

Parameters:

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.

getChangeToken

public String getChangeToken()

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.

withChangeToken

public CreateRateBasedRuleRequest withChangeToken(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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

getTags

public List<Tag> getTags()

Returns:

setTags

public void setTags(Collection<Tag> tags)

Parameters:

tags -

withTags

public CreateRateBasedRuleRequest withTags(Tag... tags)

NOTE: This method appends the values to the existing list (if any). Use setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the existing values.

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

withTags

public CreateRateBasedRuleRequest withTags(Collection<Tag> tags)

Parameters:

tags -

Returns:

Returns a reference to this object so that method calls can be chained together.

toString

public String toString()

Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public CreateRateBasedRuleRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()