AWS SDK for C++  1.9.16
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAF::Model::CreateRateBasedRuleRequest Class Reference

#include <CreateRateBasedRuleRequest.h>

+ Inheritance diagram for Aws::WAF::Model::CreateRateBasedRuleRequest:

Public Member Functions

 CreateRateBasedRuleRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
CreateRateBasedRuleRequestWithName (const Aws::String &value)
 
CreateRateBasedRuleRequestWithName (Aws::String &&value)
 
CreateRateBasedRuleRequestWithName (const char *value)
 
const Aws::StringGetMetricName () const
 
bool MetricNameHasBeenSet () const
 
void SetMetricName (const Aws::String &value)
 
void SetMetricName (Aws::String &&value)
 
void SetMetricName (const char *value)
 
CreateRateBasedRuleRequestWithMetricName (const Aws::String &value)
 
CreateRateBasedRuleRequestWithMetricName (Aws::String &&value)
 
CreateRateBasedRuleRequestWithMetricName (const char *value)
 
const RateKeyGetRateKey () const
 
bool RateKeyHasBeenSet () const
 
void SetRateKey (const RateKey &value)
 
void SetRateKey (RateKey &&value)
 
CreateRateBasedRuleRequestWithRateKey (const RateKey &value)
 
CreateRateBasedRuleRequestWithRateKey (RateKey &&value)
 
long long GetRateLimit () const
 
bool RateLimitHasBeenSet () const
 
void SetRateLimit (long long value)
 
CreateRateBasedRuleRequestWithRateLimit (long long value)
 
const Aws::StringGetChangeToken () const
 
bool ChangeTokenHasBeenSet () const
 
void SetChangeToken (const Aws::String &value)
 
void SetChangeToken (Aws::String &&value)
 
void SetChangeToken (const char *value)
 
CreateRateBasedRuleRequestWithChangeToken (const Aws::String &value)
 
CreateRateBasedRuleRequestWithChangeToken (Aws::String &&value)
 
CreateRateBasedRuleRequestWithChangeToken (const char *value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateRateBasedRuleRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateRateBasedRuleRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateRateBasedRuleRequestAddTags (const Tag &value)
 
CreateRateBasedRuleRequestAddTags (Tag &&value)
 
- Public Member Functions inherited from Aws::WAF::WAFRequest
virtual ~WAFRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 24 of file CreateRateBasedRuleRequest.h.

Constructor & Destructor Documentation

◆ CreateRateBasedRuleRequest()

Aws::WAF::Model::CreateRateBasedRuleRequest::CreateRateBasedRuleRequest ( )

Member Function Documentation

◆ AddTags() [1/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::AddTags ( const Tag value)
inline

Definition at line 360 of file CreateRateBasedRuleRequest.h.

◆ AddTags() [2/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::AddTags ( Tag &&  value)
inline

Definition at line 365 of file CreateRateBasedRuleRequest.h.

◆ ChangeTokenHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::ChangeTokenHasBeenSet ( ) const
inline

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.

Definition at line 276 of file CreateRateBasedRuleRequest.h.

◆ GetChangeToken()

const Aws::String& Aws::WAF::Model::CreateRateBasedRuleRequest::GetChangeToken ( ) const
inline

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.

Definition at line 268 of file CreateRateBasedRuleRequest.h.

◆ GetMetricName()

const Aws::String& Aws::WAF::Model::CreateRateBasedRuleRequest::GetMetricName ( ) const
inline

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.

Definition at line 97 of file CreateRateBasedRuleRequest.h.

◆ GetName()

const Aws::String& Aws::WAF::Model::CreateRateBasedRuleRequest::GetName ( ) const
inline

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

Definition at line 44 of file CreateRateBasedRuleRequest.h.

◆ GetRateKey()

const RateKey& Aws::WAF::Model::CreateRateBasedRuleRequest::GetRateKey ( ) const
inline

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.

Definition at line 177 of file CreateRateBasedRuleRequest.h.

◆ GetRateLimit()

long long Aws::WAF::Model::CreateRateBasedRuleRequest::GetRateLimit ( ) const
inline

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.

Definition at line 232 of file CreateRateBasedRuleRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WAF::Model::CreateRateBasedRuleRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WAF::WAFRequest.

◆ GetServiceRequestName()

virtual const char* Aws::WAF::Model::CreateRateBasedRuleRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file CreateRateBasedRuleRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::WAF::Model::CreateRateBasedRuleRequest::GetTags ( ) const
inline

Definition at line 330 of file CreateRateBasedRuleRequest.h.

◆ MetricNameHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::MetricNameHasBeenSet ( ) const
inline

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.

Definition at line 107 of file CreateRateBasedRuleRequest.h.

◆ NameHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::NameHasBeenSet ( ) const
inline

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

Definition at line 50 of file CreateRateBasedRuleRequest.h.

◆ RateKeyHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::RateKeyHasBeenSet ( ) const
inline

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.

Definition at line 186 of file CreateRateBasedRuleRequest.h.

◆ RateLimitHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::RateLimitHasBeenSet ( ) const
inline

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.

Definition at line 241 of file CreateRateBasedRuleRequest.h.

◆ SerializePayload()

Aws::String Aws::WAF::Model::CreateRateBasedRuleRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetChangeToken() [1/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetChangeToken ( Aws::String &&  value)
inline

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.

Definition at line 292 of file CreateRateBasedRuleRequest.h.

◆ SetChangeToken() [2/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetChangeToken ( const Aws::String value)
inline

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.

Definition at line 284 of file CreateRateBasedRuleRequest.h.

◆ SetChangeToken() [3/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetChangeToken ( const char *  value)
inline

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.

Definition at line 300 of file CreateRateBasedRuleRequest.h.

◆ SetMetricName() [1/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetMetricName ( Aws::String &&  value)
inline

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.

Definition at line 127 of file CreateRateBasedRuleRequest.h.

◆ SetMetricName() [2/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetMetricName ( const Aws::String value)
inline

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.

Definition at line 117 of file CreateRateBasedRuleRequest.h.

◆ SetMetricName() [3/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetMetricName ( const char *  value)
inline

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.

Definition at line 137 of file CreateRateBasedRuleRequest.h.

◆ SetName() [1/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetName ( Aws::String &&  value)
inline

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

Definition at line 62 of file CreateRateBasedRuleRequest.h.

◆ SetName() [2/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetName ( const Aws::String value)
inline

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

Definition at line 56 of file CreateRateBasedRuleRequest.h.

◆ SetName() [3/3]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetName ( const char *  value)
inline

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

Definition at line 68 of file CreateRateBasedRuleRequest.h.

◆ SetRateKey() [1/2]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetRateKey ( const RateKey value)
inline

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.

Definition at line 195 of file CreateRateBasedRuleRequest.h.

◆ SetRateKey() [2/2]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetRateKey ( RateKey &&  value)
inline

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.

Definition at line 204 of file CreateRateBasedRuleRequest.h.

◆ SetRateLimit()

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetRateLimit ( long long  value)
inline

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.

Definition at line 250 of file CreateRateBasedRuleRequest.h.

◆ SetTags() [1/2]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 345 of file CreateRateBasedRuleRequest.h.

◆ SetTags() [2/2]

void Aws::WAF::Model::CreateRateBasedRuleRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 340 of file CreateRateBasedRuleRequest.h.

◆ TagsHasBeenSet()

bool Aws::WAF::Model::CreateRateBasedRuleRequest::TagsHasBeenSet ( ) const
inline

Definition at line 335 of file CreateRateBasedRuleRequest.h.

◆ WithChangeToken() [1/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithChangeToken ( Aws::String &&  value)
inline

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.

Definition at line 316 of file CreateRateBasedRuleRequest.h.

◆ WithChangeToken() [2/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithChangeToken ( const Aws::String value)
inline

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.

Definition at line 308 of file CreateRateBasedRuleRequest.h.

◆ WithChangeToken() [3/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithChangeToken ( const char *  value)
inline

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.

Definition at line 324 of file CreateRateBasedRuleRequest.h.

◆ WithMetricName() [1/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithMetricName ( Aws::String &&  value)
inline

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.

Definition at line 157 of file CreateRateBasedRuleRequest.h.

◆ WithMetricName() [2/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithMetricName ( const Aws::String value)
inline

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.

Definition at line 147 of file CreateRateBasedRuleRequest.h.

◆ WithMetricName() [3/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithMetricName ( const char *  value)
inline

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.

Definition at line 167 of file CreateRateBasedRuleRequest.h.

◆ WithName() [1/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithName ( Aws::String &&  value)
inline

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

Definition at line 80 of file CreateRateBasedRuleRequest.h.

◆ WithName() [2/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithName ( const Aws::String value)
inline

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

Definition at line 74 of file CreateRateBasedRuleRequest.h.

◆ WithName() [3/3]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithName ( const char *  value)
inline

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

Definition at line 86 of file CreateRateBasedRuleRequest.h.

◆ WithRateKey() [1/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithRateKey ( const RateKey value)
inline

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.

Definition at line 213 of file CreateRateBasedRuleRequest.h.

◆ WithRateKey() [2/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithRateKey ( RateKey &&  value)
inline

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.

Definition at line 222 of file CreateRateBasedRuleRequest.h.

◆ WithRateLimit()

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithRateLimit ( long long  value)
inline

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.

Definition at line 259 of file CreateRateBasedRuleRequest.h.

◆ WithTags() [1/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

Definition at line 355 of file CreateRateBasedRuleRequest.h.

◆ WithTags() [2/2]

CreateRateBasedRuleRequest& Aws::WAF::Model::CreateRateBasedRuleRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

Definition at line 350 of file CreateRateBasedRuleRequest.h.


The documentation for this class was generated from the following file: