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.
Request Syntax
{
"Capacity": number,
"CustomResponseBodies": {
"string" : {
"Content": "string",
"ContentType": "string"
}
},
"Description": "string",
"Name": "string",
"Rules": [
{
"Action": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"ChallengeConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"Name": "string",
"OverrideAction": {
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"None": {
}
},
"Priority": number,
"RuleLabels": [
{
"Name": "string"
}
],
"Statement": {
"AndStatement": {
"Statements": [
"Statement"
]
},
"ByteMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"PositionalConstraint": "string",
"SearchString": blob,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"GeoMatchStatement": {
"CountryCodes": [ "string" ],
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
}
},
"IPSetReferenceStatement": {
"ARN": "string",
"IPSetForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string",
"Position": "string"
}
},
"LabelMatchStatement": {
"Key": "string",
"Scope": "string"
},
"ManagedRuleGroupStatement": {
"ExcludedRules": [
{
"Name": "string"
}
],
"ManagedRuleGroupConfigs": [
{
"AWSManagedRulesACFPRuleSet": {
"CreationPath": "string",
"EnableRegexInPath": boolean,
"RegistrationPagePath": "string",
"RequestInspection": {
"AddressFields": [
{
"Identifier": "string"
}
],
"EmailField": {
"Identifier": "string"
},
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"PhoneNumberFields": [
{
"Identifier": "string"
}
],
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesATPRuleSet": {
"EnableRegexInPath": boolean,
"LoginPath": "string",
"RequestInspection": {
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
},
"ResponseInspection": {
"BodyContains": {
"FailureStrings": [ "string" ],
"SuccessStrings": [ "string" ]
},
"Header": {
"FailureValues": [ "string" ],
"Name": "string",
"SuccessValues": [ "string" ]
},
"Json": {
"FailureValues": [ "string" ],
"Identifier": "string",
"SuccessValues": [ "string" ]
},
"StatusCode": {
"FailureCodes": [ number ],
"SuccessCodes": [ number ]
}
}
},
"AWSManagedRulesBotControlRuleSet": {
"EnableMachineLearning": boolean,
"InspectionLevel": "string"
},
"LoginPath": "string",
"PasswordField": {
"Identifier": "string"
},
"PayloadType": "string",
"UsernameField": {
"Identifier": "string"
}
}
],
"Name": "string",
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
],
"ScopeDownStatement": "Statement",
"VendorName": "string",
"Version": "string"
},
"NotStatement": {
"Statement": "Statement"
},
"OrStatement": {
"Statements": [
"Statement"
]
},
"RateBasedStatement": {
"AggregateKeyType": "string",
"CustomKeys": [
{
"Cookie": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"ForwardedIP": {
},
"Header": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"HTTPMethod": {
},
"IP": {
},
"LabelNamespace": {
"Namespace": "string"
},
"QueryArgument": {
"Name": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"QueryString": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"UriPath": {
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
}
],
"EvaluationWindowSec": number,
"ForwardedIPConfig": {
"FallbackBehavior": "string",
"HeaderName": "string"
},
"Limit": number,
"ScopeDownStatement": "Statement"
},
"RegexMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"RegexString": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RegexPatternSetReferenceStatement": {
"ARN": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"RuleGroupReferenceStatement": {
"ARN": "string",
"ExcludedRules": [
{
"Name": "string"
}
],
"RuleActionOverrides": [
{
"ActionToUse": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string",
"ResponseCode": number,
"ResponseHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Captcha": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Challenge": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
},
"Count": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string",
"Value": "string"
}
]
}
}
},
"Name": "string"
}
]
},
"SizeConstraintStatement": {
"ComparisonOperator": "string",
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"Size": number,
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"SqliMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"SensitivityLevel": "string",
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
},
"XssMatchStatement": {
"FieldToMatch": {
"AllQueryArguments": {
},
"Body": {
"OversizeHandling": "string"
},
"Cookies": {
"MatchPattern": {
"All": {
},
"ExcludedCookies": [ "string" ],
"IncludedCookies": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"HeaderOrder": {
"OversizeHandling": "string"
},
"Headers": {
"MatchPattern": {
"All": {
},
"ExcludedHeaders": [ "string" ],
"IncludedHeaders": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"JA3Fingerprint": {
"FallbackBehavior": "string"
},
"JsonBody": {
"InvalidFallbackBehavior": "string",
"MatchPattern": {
"All": {
},
"IncludedPaths": [ "string" ]
},
"MatchScope": "string",
"OversizeHandling": "string"
},
"Method": {
},
"QueryString": {
},
"SingleHeader": {
"Name": "string"
},
"SingleQueryArgument": {
"Name": "string"
},
"UriPath": {
}
},
"TextTransformations": [
{
"Priority": number,
"Type": "string"
}
]
}
},
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}
],
"Scope": "string",
"Tags": [
{
"Key": "string",
"Value": "string"
}
],
"VisibilityConfig": {
"CloudWatchMetricsEnabled": boolean,
"MetricName": "string",
"SampledRequestsEnabled": boolean
}
}Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- Capacity
-
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. For more information, see AWS WAF web ACL capacity units (WCU) in the AWS WAF Developer Guide.
Type: Long
Valid Range: Minimum value of 1.
Required: Yes
- 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 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.
Type: String to CustomResponseBody object map
Map Entries: Maximum number of items.
Key Length Constraints: Minimum length of 1. Maximum length of 128.
Key Pattern:
^[\w\-]+$Required: No
- Description
-
A description of the rule group that helps with identification.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$Required: No
- Name
-
The name of the rule group. You cannot change the name of a rule group after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w\-]+$Required: Yes
- Rules
-
The Rule statements used to identify the web requests that you want to manage. 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.
Type: Array of Rule objects
Required: No
- Scope
-
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 AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS 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.
Type: String
Valid Values:
CLOUDFRONT | REGIONALRequired: Yes
-
- Tags
-
An array of key:value pairs to associate with the resource.
Type: Array of Tag objects
Array Members: Minimum number of 1 item.
Required: No
- VisibilityConfig
-
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Type: VisibilityConfig object
Required: Yes
Response Syntax
{
"Summary": {
"ARN": "string",
"Description": "string",
"Id": "string",
"LockToken": "string",
"Name": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- Summary
-
High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a
RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.Type: RuleGroupSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFDuplicateItemException
-
AWS WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
HTTP Status Code: 400
- WAFInternalErrorException
-
Your request is valid, but AWS WAF couldn’t perform the operation because of a system problem. Retry your request.
HTTP Status Code: 500
- WAFInvalidOperationException
-
The operation isn't valid.
HTTP Status Code: 400
- WAFInvalidParameterException
-
The operation failed because AWS WAF didn't recognize a parameter in the request. For example:
-
You specified a parameter name or value that isn't valid.
-
Your nested statement isn't valid. You might have tried to nest a statement that can’t be nested.
-
You tried to update a
WebACLwith aDefaultActionthat isn't among the types available at DefaultAction. -
Your request references an ARN that is malformed, or corresponds to a resource with which a web ACL can't be associated.
HTTP Status Code: 400
-
- WAFLimitsExceededException
-
AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of
WebACLobjects that you can create for an AWS account. For more information, see AWS WAF quotas in the AWS WAF Developer Guide.HTTP Status Code: 400
- WAFNonexistentItemException
-
AWS WAF couldn’t perform the operation because your resource doesn't exist. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate.
HTTP Status Code: 400
- WAFOptimisticLockException
-
AWS WAF couldn’t save your changes because you tried to update or delete a resource that has changed since you last retrieved it. Get the resource again, make any changes you need to make to the new copy, and retry your operation.
HTTP Status Code: 400
- WAFSubscriptionNotFoundException
-
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
HTTP Status Code: 400
- WAFTagOperationException
-
An error occurred during the tagging operation. Retry your request.
HTTP Status Code: 400
- WAFTagOperationInternalErrorException
-
AWS WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
HTTP Status Code: 500
- WAFUnavailableEntityException
-
AWS WAF couldn’t retrieve a resource that you specified for this operation. If you've just created a resource that you're using in this operation, you might just need to wait a few minutes. It can take from a few seconds to a number of minutes for changes to propagate. Verify the resources that you are specifying in your request parameters and then retry the operation.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
