AWS SDK for C++  1.9.18
AWS SDK for C++
Public Member Functions | List of all members
Aws::WAFV2::Model::CreateRuleGroupRequest Class Reference

#include <CreateRuleGroupRequest.h>

+ Inheritance diagram for Aws::WAFV2::Model::CreateRuleGroupRequest:

Public Member Functions

 CreateRuleGroupRequest ()
 
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)
 
CreateRuleGroupRequestWithName (const Aws::String &value)
 
CreateRuleGroupRequestWithName (Aws::String &&value)
 
CreateRuleGroupRequestWithName (const char *value)
 
const ScopeGetScope () const
 
bool ScopeHasBeenSet () const
 
void SetScope (const Scope &value)
 
void SetScope (Scope &&value)
 
CreateRuleGroupRequestWithScope (const Scope &value)
 
CreateRuleGroupRequestWithScope (Scope &&value)
 
long long GetCapacity () const
 
bool CapacityHasBeenSet () const
 
void SetCapacity (long long value)
 
CreateRuleGroupRequestWithCapacity (long long value)
 
const Aws::StringGetDescription () const
 
bool DescriptionHasBeenSet () const
 
void SetDescription (const Aws::String &value)
 
void SetDescription (Aws::String &&value)
 
void SetDescription (const char *value)
 
CreateRuleGroupRequestWithDescription (const Aws::String &value)
 
CreateRuleGroupRequestWithDescription (Aws::String &&value)
 
CreateRuleGroupRequestWithDescription (const char *value)
 
const Aws::Vector< Rule > & GetRules () const
 
bool RulesHasBeenSet () const
 
void SetRules (const Aws::Vector< Rule > &value)
 
void SetRules (Aws::Vector< Rule > &&value)
 
CreateRuleGroupRequestWithRules (const Aws::Vector< Rule > &value)
 
CreateRuleGroupRequestWithRules (Aws::Vector< Rule > &&value)
 
CreateRuleGroupRequestAddRules (const Rule &value)
 
CreateRuleGroupRequestAddRules (Rule &&value)
 
const VisibilityConfigGetVisibilityConfig () const
 
bool VisibilityConfigHasBeenSet () const
 
void SetVisibilityConfig (const VisibilityConfig &value)
 
void SetVisibilityConfig (VisibilityConfig &&value)
 
CreateRuleGroupRequestWithVisibilityConfig (const VisibilityConfig &value)
 
CreateRuleGroupRequestWithVisibilityConfig (VisibilityConfig &&value)
 
const Aws::Vector< Tag > & GetTags () const
 
bool TagsHasBeenSet () const
 
void SetTags (const Aws::Vector< Tag > &value)
 
void SetTags (Aws::Vector< Tag > &&value)
 
CreateRuleGroupRequestWithTags (const Aws::Vector< Tag > &value)
 
CreateRuleGroupRequestWithTags (Aws::Vector< Tag > &&value)
 
CreateRuleGroupRequestAddTags (const Tag &value)
 
CreateRuleGroupRequestAddTags (Tag &&value)
 
const Aws::Map< Aws::String, CustomResponseBody > & GetCustomResponseBodies () const
 
bool CustomResponseBodiesHasBeenSet () const
 
void SetCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
void SetCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
CreateRuleGroupRequestWithCustomResponseBodies (const Aws::Map< Aws::String, CustomResponseBody > &value)
 
CreateRuleGroupRequestWithCustomResponseBodies (Aws::Map< Aws::String, CustomResponseBody > &&value)
 
CreateRuleGroupRequestAddCustomResponseBodies (const Aws::String &key, const CustomResponseBody &value)
 
CreateRuleGroupRequestAddCustomResponseBodies (Aws::String &&key, const CustomResponseBody &value)
 
CreateRuleGroupRequestAddCustomResponseBodies (const Aws::String &key, CustomResponseBody &&value)
 
CreateRuleGroupRequestAddCustomResponseBodies (Aws::String &&key, CustomResponseBody &&value)
 
CreateRuleGroupRequestAddCustomResponseBodies (const char *key, CustomResponseBody &&value)
 
CreateRuleGroupRequestAddCustomResponseBodies (const char *key, const CustomResponseBody &value)
 
- Public Member Functions inherited from Aws::WAFV2::WAFV2Request
virtual ~WAFV2Request ()
 
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 28 of file CreateRuleGroupRequest.h.

Constructor & Destructor Documentation

◆ CreateRuleGroupRequest()

Aws::WAFV2::Model::CreateRuleGroupRequest::CreateRuleGroupRequest ( )

Member Function Documentation

◆ AddCustomResponseBodies() [1/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( Aws::String &&  key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 547 of file CreateRuleGroupRequest.h.

◆ AddCustomResponseBodies() [2/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( Aws::String &&  key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 583 of file CreateRuleGroupRequest.h.

◆ AddCustomResponseBodies() [3/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( const Aws::String key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 529 of file CreateRuleGroupRequest.h.

◆ AddCustomResponseBodies() [4/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( const Aws::String key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 565 of file CreateRuleGroupRequest.h.

◆ AddCustomResponseBodies() [5/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( const char *  key,
const CustomResponseBody value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 619 of file CreateRuleGroupRequest.h.

◆ AddCustomResponseBodies() [6/6]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddCustomResponseBodies ( const char *  key,
CustomResponseBody &&  value 
)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 601 of file CreateRuleGroupRequest.h.

◆ AddRules() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddRules ( const Rule value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 316 of file CreateRuleGroupRequest.h.

◆ AddRules() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddRules ( Rule &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 324 of file CreateRuleGroupRequest.h.

◆ AddTags() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddTags ( const Tag value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 397 of file CreateRuleGroupRequest.h.

◆ AddTags() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::AddTags ( Tag &&  value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 402 of file CreateRuleGroupRequest.h.

◆ CapacityHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::CapacityHasBeenSet ( ) const
inline

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Definition at line 188 of file CreateRuleGroupRequest.h.

◆ CustomResponseBodiesHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::CustomResponseBodiesHasBeenSet ( ) const
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 439 of file CreateRuleGroupRequest.h.

◆ DescriptionHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::DescriptionHasBeenSet ( ) const
inline

A description of the rule group that helps with identification.

Definition at line 229 of file CreateRuleGroupRequest.h.

◆ GetCapacity()

long long Aws::WAFV2::Model::CreateRuleGroupRequest::GetCapacity ( ) const
inline

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Definition at line 173 of file CreateRuleGroupRequest.h.

◆ GetCustomResponseBodies()

const Aws::Map<Aws::String, CustomResponseBody>& Aws::WAFV2::Model::CreateRuleGroupRequest::GetCustomResponseBodies ( ) const
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 421 of file CreateRuleGroupRequest.h.

◆ GetDescription()

const Aws::String& Aws::WAFV2::Model::CreateRuleGroupRequest::GetDescription ( ) const
inline

A description of the rule group that helps with identification.

Definition at line 224 of file CreateRuleGroupRequest.h.

◆ GetName()

const Aws::String& Aws::WAFV2::Model::CreateRuleGroupRequest::GetName ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 48 of file CreateRuleGroupRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::WAFV2::Model::CreateRuleGroupRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::WAFV2::WAFV2Request.

◆ GetRules()

const Aws::Vector<Rule>& Aws::WAFV2::Model::CreateRuleGroupRequest::GetRules ( ) const
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 268 of file CreateRuleGroupRequest.h.

◆ GetScope()

const Scope& Aws::WAFV2::Model::CreateRuleGroupRequest::GetScope ( ) const
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 102 of file CreateRuleGroupRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::WAFV2::Model::CreateRuleGroupRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 37 of file CreateRuleGroupRequest.h.

◆ GetTags()

const Aws::Vector<Tag>& Aws::WAFV2::Model::CreateRuleGroupRequest::GetTags ( ) const
inline

An array of key:value pairs to associate with the resource.

Definition at line 367 of file CreateRuleGroupRequest.h.

◆ GetVisibilityConfig()

const VisibilityConfig& Aws::WAFV2::Model::CreateRuleGroupRequest::GetVisibilityConfig ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 331 of file CreateRuleGroupRequest.h.

◆ NameHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::NameHasBeenSet ( ) const
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 54 of file CreateRuleGroupRequest.h.

◆ RulesHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::RulesHasBeenSet ( ) const
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 276 of file CreateRuleGroupRequest.h.

◆ ScopeHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::ScopeHasBeenSet ( ) const
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 113 of file CreateRuleGroupRequest.h.

◆ SerializePayload()

Aws::String Aws::WAFV2::Model::CreateRuleGroupRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetCapacity()

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetCapacity ( long long  value)
inline

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Definition at line 203 of file CreateRuleGroupRequest.h.

◆ SetCustomResponseBodies() [1/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 475 of file CreateRuleGroupRequest.h.

◆ SetCustomResponseBodies() [2/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 457 of file CreateRuleGroupRequest.h.

◆ SetDescription() [1/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetDescription ( Aws::String &&  value)
inline

A description of the rule group that helps with identification.

Definition at line 239 of file CreateRuleGroupRequest.h.

◆ SetDescription() [2/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetDescription ( const Aws::String value)
inline

A description of the rule group that helps with identification.

Definition at line 234 of file CreateRuleGroupRequest.h.

◆ SetDescription() [3/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetDescription ( const char *  value)
inline

A description of the rule group that helps with identification.

Definition at line 244 of file CreateRuleGroupRequest.h.

◆ SetName() [1/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 66 of file CreateRuleGroupRequest.h.

◆ SetName() [2/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 60 of file CreateRuleGroupRequest.h.

◆ SetName() [3/3]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 72 of file CreateRuleGroupRequest.h.

◆ SetRules() [1/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetRules ( Aws::Vector< Rule > &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 292 of file CreateRuleGroupRequest.h.

◆ SetRules() [2/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetRules ( const Aws::Vector< Rule > &  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 284 of file CreateRuleGroupRequest.h.

◆ SetScope() [1/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetScope ( const Scope value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 124 of file CreateRuleGroupRequest.h.

◆ SetScope() [2/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetScope ( Scope &&  value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 135 of file CreateRuleGroupRequest.h.

◆ SetTags() [1/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetTags ( Aws::Vector< Tag > &&  value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 382 of file CreateRuleGroupRequest.h.

◆ SetTags() [2/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetTags ( const Aws::Vector< Tag > &  value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 377 of file CreateRuleGroupRequest.h.

◆ SetVisibilityConfig() [1/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 343 of file CreateRuleGroupRequest.h.

◆ SetVisibilityConfig() [2/2]

void Aws::WAFV2::Model::CreateRuleGroupRequest::SetVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 349 of file CreateRuleGroupRequest.h.

◆ TagsHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::TagsHasBeenSet ( ) const
inline

An array of key:value pairs to associate with the resource.

Definition at line 372 of file CreateRuleGroupRequest.h.

◆ VisibilityConfigHasBeenSet()

bool Aws::WAFV2::Model::CreateRuleGroupRequest::VisibilityConfigHasBeenSet ( ) const
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 337 of file CreateRuleGroupRequest.h.

◆ WithCapacity()

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithCapacity ( long long  value)
inline

The web ACL capacity units (WCUs) required for this rule group.

When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Definition at line 218 of file CreateRuleGroupRequest.h.

◆ WithCustomResponseBodies() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithCustomResponseBodies ( Aws::Map< Aws::String, CustomResponseBody > &&  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 511 of file CreateRuleGroupRequest.h.

◆ WithCustomResponseBodies() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithCustomResponseBodies ( const Aws::Map< Aws::String, CustomResponseBody > &  value)
inline

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.

For information about customizing web requests and responses, see Customizing web requests and responses in AWS WAF in the AWS WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see AWS WAF quotas in the AWS WAF Developer Guide.

Definition at line 493 of file CreateRuleGroupRequest.h.

◆ WithDescription() [1/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithDescription ( Aws::String &&  value)
inline

A description of the rule group that helps with identification.

Definition at line 254 of file CreateRuleGroupRequest.h.

◆ WithDescription() [2/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithDescription ( const Aws::String value)
inline

A description of the rule group that helps with identification.

Definition at line 249 of file CreateRuleGroupRequest.h.

◆ WithDescription() [3/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithDescription ( const char *  value)
inline

A description of the rule group that helps with identification.

Definition at line 259 of file CreateRuleGroupRequest.h.

◆ WithName() [1/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithName ( Aws::String &&  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 84 of file CreateRuleGroupRequest.h.

◆ WithName() [2/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithName ( const Aws::String value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 78 of file CreateRuleGroupRequest.h.

◆ WithName() [3/3]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithName ( const char *  value)
inline

The name of the rule group. You cannot change the name of a rule group after you create it.

Definition at line 90 of file CreateRuleGroupRequest.h.

◆ WithRules() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithRules ( Aws::Vector< Rule > &&  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 308 of file CreateRuleGroupRequest.h.

◆ WithRules() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithRules ( const Aws::Vector< Rule > &  value)
inline

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.

Definition at line 300 of file CreateRuleGroupRequest.h.

◆ WithScope() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithScope ( const Scope value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 146 of file CreateRuleGroupRequest.h.

◆ WithScope() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithScope ( Scope &&  value)
inline

Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

  • CLI - Specify the Region when you use the CloudFront scope: –scope=CLOUDFRONT –region=us-east-1.

  • API and SDKs - For all calls, use the Region endpoint us-east-1.

Definition at line 157 of file CreateRuleGroupRequest.h.

◆ WithTags() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithTags ( Aws::Vector< Tag > &&  value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 392 of file CreateRuleGroupRequest.h.

◆ WithTags() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithTags ( const Aws::Vector< Tag > &  value)
inline

An array of key:value pairs to associate with the resource.

Definition at line 387 of file CreateRuleGroupRequest.h.

◆ WithVisibilityConfig() [1/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithVisibilityConfig ( const VisibilityConfig value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 355 of file CreateRuleGroupRequest.h.

◆ WithVisibilityConfig() [2/2]

CreateRuleGroupRequest& Aws::WAFV2::Model::CreateRuleGroupRequest::WithVisibilityConfig ( VisibilityConfig &&  value)
inline

Defines and enables Amazon CloudWatch metrics and web request sample collection.

Definition at line 361 of file CreateRuleGroupRequest.h.


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