CreateWebACL
Creates a WebACL per the specifications provided.
A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that AWS WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more AWS resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, or an AWS Verified Access instance.
Request Syntax
{
"AssociationConfig": {
"RequestBody": {
"string
" : {
"DefaultSizeInspectionLimit": "string
"
}
}
},
"CaptchaConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"ChallengeConfig": {
"ImmunityTimeProperty": {
"ImmunityTime": number
}
},
"CustomResponseBodies": {
"string
" : {
"Content": "string
",
"ContentType": "string
"
}
},
"DefaultAction": {
"Allow": {
"CustomRequestHandling": {
"InsertHeaders": [
{
"Name": "string
",
"Value": "string
"
}
]
}
},
"Block": {
"CustomResponse": {
"CustomResponseBodyKey": "string
",
"ResponseCode": number
,
"ResponseHeaders": [
{
"Name": "string
",
"Value": "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
"
}
],
"TokenDomains": [ "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.
- AssociationConfig
-
Specifies custom configurations for the associations between the web ACL and protected resources.
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).
Note
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see AWS WAF Pricing
. For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).
Type: AssociationConfig object
Required: No
- CaptchaConfig
-
Specifies how AWS WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, AWS WAF uses its default settings forCaptchaConfig
.Type: CaptchaConfig object
Required: No
- ChallengeConfig
-
Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, AWS WAF uses its default settings forChallengeConfig
.Type: ChallengeConfig object
Required: No
- 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 web ACL, and then use them in the rules and default actions that you define in the web ACL.
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
- DefaultAction
-
The action to perform if none of the
Rules
contained in theWebACL
match.Type: DefaultAction object
Required: Yes
- Description
-
A description of the web ACL 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 web ACL. You cannot change the name of a web ACL 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 | REGIONAL
Required: 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
- TokenDomains
-
Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON:
"TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use
gov.au
orco.uk
as token domains.Type: Array of strings
Length Constraints: Minimum length of 1. Maximum length of 253.
Pattern:
^[\w\.\-/]+$
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 WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a
WebACL
, and the ARN, that you provide to operations like AssociateWebACL.Type: WebACLSummary object
Errors
For information about the errors that are common to all actions, see Common Errors.
- WAFConfigurationWarningException
-
The operation failed because you are inspecting the web request body, headers, or cookies without specifying how to handle oversize components. Rules that inspect the body must either provide an
OversizeHandling
configuration or they must be preceded by aSizeConstraintStatement
that blocks the body content from being too large. Rules that inspect the headers or cookies must provide anOversizeHandling
configuration.Provide the handling configuration and retry your operation.
Alternately, you can suppress this warning by adding the following tag to the resource that you provide to this operation:
Tag
(key:WAF:OversizeFieldsHandlingConstraintOptOut
, value:true
).HTTP Status Code: 400
- 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
- WAFExpiredManagedRuleGroupVersionException
-
The operation failed because the specified version for the managed rule group has expired. You can retrieve the available versions for the managed rule group by calling ListAvailableManagedRuleGroupVersions.
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
WebACL
with aDefaultAction
that 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
-
- WAFInvalidResourceException
-
AWS WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
HTTP Status Code: 400
- WAFLimitsExceededException
-
AWS WAF couldn’t perform the operation because you exceeded your resource limit. For example, the maximum number of
WebACL
objects 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
Examples
Create a web ACL
The following example lists a web ACL JSON with multiple rules, including one that references a managed rule group. The managed rule group reference statement includes additional managed rule group configuration.
{ "Name": "exampleWebACL", "Id": "77777777-8888-9999-0000-111111111111", "ARN": "arn:aws:wafv2:us-east-1:111111111111:regional/webacl/exampleWebACL/00000000-9999-8888-7777-666666666666", "DefaultAction": { "Allow": {} }, "Description": "", "Rules": [ { "Name": "exampleIPSetRule", "Priority": 0, "Statement": { "IPSetReferenceStatement": { "ARN": "arn:aws:wafv2:us-east-1:111111111111:regional/ipset/da/00000000-1111-2222-3333-444444444444" } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleIPSetRule" } }, { "Name": "exampleGeoMatchRule", "Priority": 1, "Statement": { "GeoMatchStatement": { "CountryCodes": [ "AQ", "RE" ] } }, "Action": { "Block": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleGeoMatchRule" } }, { "Name": "AWS-AWSManagedRulesATPRuleSet", "Priority": 2, "Statement": { "ManagedRuleGroupStatement": { "VendorName": "AWS", "Name": "AWSManagedRulesATPRuleSet", "ManagedRuleGroupConfigs": [ { "LoginPath": "/web/login" }, { "PayloadType": "JSON" }, { "UsernameField": { "Identifier": "/form/username" } }, { "PasswordField": { "Identifier": "/form/password" } } ] } }, "OverrideAction": { "None": {} }, "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "AWS-AWSManagedRulesATPRuleSet" } } ], "VisibilityConfig": { "SampledRequestsEnabled": true, "CloudWatchMetricsEnabled": true, "MetricName": "exampleWebACL" }, "Capacity": 52, "ManagedByFirewallManager": false, "RetrofittedByFirewallManager": false, "LabelNamespace": "awswaf:111111111111:webacl:exampleWebACL:" }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: