/AWS1/CL_WA2=>CREATERULEGROUP()¶
About CreateRuleGroup¶
Creates a RuleGroup per the specifications provided.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
Method Signature¶
IMPORTING¶
Required arguments:¶
IV_NAME TYPE /AWS1/WA2ENTITYNAME /AWS1/WA2ENTITYNAME¶
The name of the rule group. You cannot change the name of a rule group after you create it.
IV_SCOPE TYPE /AWS1/WA2SCOPE /AWS1/WA2SCOPE¶
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
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.
IV_CAPACITY TYPE /AWS1/WA2CAPACITYUNIT /AWS1/WA2CAPACITYUNIT¶
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, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. 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. For more information, see WAF web ACL capacity units (WCU) in the WAF Developer Guide.
IO_VISIBILITYCONFIG TYPE REF TO /AWS1/CL_WA2VISIBILITYCONFIG /AWS1/CL_WA2VISIBILITYCONFIG¶
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Optional arguments:¶
IV_DESCRIPTION TYPE /AWS1/WA2ENTITYDESCRIPTION /AWS1/WA2ENTITYDESCRIPTION¶
A description of the rule group that helps with identification.
IT_RULES TYPE /AWS1/CL_WA2RULE=>TT_RULES TT_RULES¶
The Rule statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that WAF uses to identify matching
web requests, and parameters that govern how WAF handles them.
IT_TAGS TYPE /AWS1/CL_WA2TAG=>TT_TAGLIST TT_TAGLIST¶
An array of key:value pairs to associate with the resource.
IT_CUSTOMRESPONSEBODIES TYPE /AWS1/CL_WA2CUSTOMRESPONSEBODY=>TT_CUSTOMRESPONSEBODIES TT_CUSTOMRESPONSEBODIES¶
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 WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.