AWS WAFV2 2019-07-29
- Client: Aws\WAFV2\WAFV2Client
- Service ID: wafv2
- Version: 2019-07-29
This page describes the parameters and results for the operations of the AWS WAFV2 (2019-07-29), and shows how to use the Aws\WAFV2\WAFV2Client object to call the described operations. This documentation is specific to the 2019-07-29 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName')
, where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */)
.
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */)
.
- AssociateWebACL ( array $params = [] )
- Associates a web ACL with a regional application resource, to protect the resource.
- CheckCapacity ( array $params = [] )
- Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules.
- CreateAPIKey ( array $params = [] )
- Creates an API key that contains a set of token domains.
- CreateIPSet ( array $params = [] )
- Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses.
- CreateRegexPatternSet ( array $params = [] )
- Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
- CreateRuleGroup ( array $params = [] )
- Creates a RuleGroup per the specifications provided.
- CreateWebACL ( array $params = [] )
- Creates a WebACL per the specifications provided.
- DeleteAPIKey ( array $params = [] )
- Deletes the specified API key.
- DeleteFirewallManagerRuleGroups ( array $params = [] )
- Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.
- DeleteIPSet ( array $params = [] )
- Deletes the specified IPSet.
- DeleteLoggingConfiguration ( array $params = [] )
- Deletes the LoggingConfiguration from the specified web ACL.
- DeletePermissionPolicy ( array $params = [] )
- Permanently deletes an IAM policy from the specified rule group.
- DeleteRegexPatternSet ( array $params = [] )
- Deletes the specified RegexPatternSet.
- DeleteRuleGroup ( array $params = [] )
- Deletes the specified RuleGroup.
- DeleteWebACL ( array $params = [] )
- Deletes the specified WebACL.
- DescribeAllManagedProducts ( array $params = [] )
- Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
- DescribeManagedProductsByVendor ( array $params = [] )
- Provides high-level information for the managed rule groups owned by a specific vendor.
- DescribeManagedRuleGroup ( array $params = [] )
- Provides high-level information for a managed rule group, including descriptions of the rules.
- DisassociateWebACL ( array $params = [] )
- Disassociates the specified regional application resource from any existing web ACL association.
- GenerateMobileSdkReleaseUrl ( array $params = [] )
- Generates a presigned download URL for the specified release of the mobile SDK.
- GetDecryptedAPIKey ( array $params = [] )
- Returns your API key in decrypted form.
- GetIPSet ( array $params = [] )
- Retrieves the specified IPSet.
- GetLoggingConfiguration ( array $params = [] )
- Returns the LoggingConfiguration for the specified web ACL.
- GetManagedRuleSet ( array $params = [] )
- Retrieves the specified managed rule set.
- GetMobileSdkRelease ( array $params = [] )
- Retrieves information for the specified mobile SDK release, including release notes and tags.
- GetPermissionPolicy ( array $params = [] )
- Returns the IAM policy that is attached to the specified rule group.
- GetRateBasedStatementManagedKeys ( array $params = [] )
- Retrieves the IP addresses that are currently blocked by a rate-based rule instance.
- GetRegexPatternSet ( array $params = [] )
- Retrieves the specified RegexPatternSet.
- GetRuleGroup ( array $params = [] )
- Retrieves the specified RuleGroup.
- GetSampledRequests ( array $params = [] )
- Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose.
- GetWebACL ( array $params = [] )
- Retrieves the specified WebACL.
- GetWebACLForResource ( array $params = [] )
- Retrieves the WebACL for the specified resource.
- ListAPIKeys ( array $params = [] )
- Retrieves a list of the API keys that you've defined for the specified scope.
- ListAvailableManagedRuleGroupVersions ( array $params = [] )
- Returns a list of the available versions for the specified managed rule group.
- ListAvailableManagedRuleGroups ( array $params = [] )
- Retrieves an array of managed rule groups that are available for you to use.
- ListIPSets ( array $params = [] )
- Retrieves an array of IPSetSummary objects for the IP sets that you manage.
- ListLoggingConfigurations ( array $params = [] )
- Retrieves an array of your LoggingConfiguration objects.
- ListManagedRuleSets ( array $params = [] )
- Retrieves the managed rule sets that you own.
- ListMobileSdkReleases ( array $params = [] )
- Retrieves a list of the available releases for the mobile SDK and the specified device platform.
- ListRegexPatternSets ( array $params = [] )
- Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
- ListResourcesForWebACL ( array $params = [] )
- Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
- ListRuleGroups ( array $params = [] )
- Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
- ListTagsForResource ( array $params = [] )
- Retrieves the TagInfoForResource for the specified resource.
- ListWebACLs ( array $params = [] )
- Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
- PutLoggingConfiguration ( array $params = [] )
- Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
- PutManagedRuleSetVersions ( array $params = [] )
- Defines the versions of your managed rule set that you are offering to the customers.
- PutPermissionPolicy ( array $params = [] )
- Use this to share a rule group with other accounts.
- TagResource ( array $params = [] )
- Associates tags with the specified Amazon Web Services resource.
- UntagResource ( array $params = [] )
- Disassociates tags from an Amazon Web Services resource.
- UpdateIPSet ( array $params = [] )
- Updates the specified IPSet.
- UpdateManagedRuleSetVersionExpiryDate ( array $params = [] )
- Updates the expiration information for your managed rule set.
- UpdateRegexPatternSet ( array $params = [] )
- Updates the specified RegexPatternSet.
- UpdateRuleGroup ( array $params = [] )
- Updates the specified RuleGroup.
- UpdateWebACL ( array $params = [] )
- Updates the specified WebACL.
Operations
AssociateWebACL
$result = $client->associateWebACL
([/* ... */]); $promise = $client->associateWebACLAsync
([/* ... */]);
Associates a web ACL with a regional application resource, to protect the resource. 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.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a web ACL, in the CloudFront call UpdateDistribution
, set the web ACL ID to the Amazon Resource Name (ARN) of the web ACL. For information, see UpdateDistribution in the Amazon CloudFront Developer Guide.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the WAF Developer Guide.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Parameter Syntax
$result = $client->associateWebACL([ 'ResourceArn' => '<string>', // REQUIRED 'WebACLArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
-
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId
-
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
-
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
-
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
- WebACLArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFUnavailableEntityException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
CheckCapacity
$result = $client->checkCapacity
([/* ... */]); $promise = $client->checkCapacityAsync
([/* ... */]);
Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.
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.
Parameter Syntax
$result = $client->checkCapacity([ 'Rules' => [ // REQUIRED [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, // REQUIRED 'RuleLabels' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Statement' => [ // REQUIRED 'AndStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED 'Position' => 'FIRST|LAST|ANY', // REQUIRED ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', // REQUIRED 'Scope' => 'LABEL|NAMESPACE', // REQUIRED ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', // REQUIRED 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', // REQUIRED 'RequestInspection' => [ // REQUIRED 'AddressFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'PhoneNumberFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', // REQUIRED 'RequestInspection' => [ 'PasswordField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'UsernameField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], 'ScopeDownStatement' => [...], // RECURSIVE 'VendorName' => '<string>', // REQUIRED 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // REQUIRED, RECURSIVE ], 'OrStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', // REQUIRED 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', // REQUIRED ], 'QueryArgument' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], 'Limit' => <integer>, // REQUIRED 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'RegexString' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], ], 'SizeConstraintStatement' => [ 'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'Size' => <integer>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Rules
-
- Required: Yes
- Type: Array of Rule structures
An array of Rule that you're configuring to use in a rule group or web ACL.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'Capacity' => <integer>, ]
Result Details
Members
- Capacity
-
- Type: long (int|float)
The capacity required by the rules and scope.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
- WAFUnavailableEntityException:
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.
- WAFSubscriptionNotFoundException:
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
- 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.
- WAFInvalidOperationException:
The operation isn't valid.
CreateAPIKey
$result = $client->createAPIKey
([/* ... */]); $promise = $client->createAPIKeyAsync
([/* ... */]);
Creates an API key that contains a set of token domains.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
You can use a single key for up to 5 domains. After you generate a key, you can copy it for use in your JavaScript integration.
Parameter Syntax
$result = $client->createAPIKey([ 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'TokenDomains' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- Scope
-
- Required: Yes
- Type: string
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.
- TokenDomains
-
- Required: Yes
- Type: Array of strings
The client application domains that you want to use this API key for.
Example JSON:
"TokenDomains": ["abc.com", "store.abc.com"]
Public suffixes aren't allowed. For example, you can't use
gov.au
orco.uk
as token domains.
Result Syntax
[ 'APIKey' => '<string>', ]
Result Details
Members
- APIKey
-
- Type: string
The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
CreateIPSet
$result = $client->createIPSet
([/* ... */]); $promise = $client->createIPSetAsync
([/* ... */]);
Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure WAF to block them using an IPSet that lists those IP addresses.
Parameter Syntax
$result = $client->createIPSet([ 'Addresses' => ['<string>', ...], // REQUIRED 'Description' => '<string>', 'IPAddressVersion' => 'IPV4|IPV6', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Addresses
-
- Required: Yes
- Type: Array of strings
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for
/0
.Example address strings:
-
For requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32
. -
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
. -
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON
Addresses
specifications:-
Empty array:
"Addresses": []
-
Array with one address:
"Addresses": ["192.0.2.44/32"]
-
Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
-
INVALID specification:
"Addresses": [""]
INVALID
- Description
-
- Type: string
A description of the IP set that helps with identification.
- IPAddressVersion
-
- Required: Yes
- Type: string
The version of the IP addresses, either
IPV4
orIPV6
. - Name
-
- Required: Yes
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it. - Scope
-
- Required: Yes
- Type: string
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.
- Tags
-
- Type: Array of Tag structures
An array of key:value pairs to associate with the resource.
Result Syntax
[ 'Summary' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- Summary
-
- Type: IPSetSummary structure
High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an
IPSet
, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
CreateRegexPatternSet
$result = $client->createRegexPatternSet
([/* ... */]); $promise = $client->createRegexPatternSetAsync
([/* ... */]);
Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have WAF inspect a web request component for the specified patterns.
Parameter Syntax
$result = $client->createRegexPatternSet([ 'Description' => '<string>', 'Name' => '<string>', // REQUIRED 'RegularExpressionList' => [ // REQUIRED [ 'RegexString' => '<string>', ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the set that helps with identification.
- Name
-
- Required: Yes
- Type: string
The name of the set. You cannot change the name after you create the set.
- RegularExpressionList
-
- Required: Yes
- Type: Array of Regex structures
Array of regular expression strings.
- Scope
-
- Required: Yes
- Type: string
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.
- Tags
-
- Type: Array of Tag structures
An array of key:value pairs to associate with the resource.
Result Syntax
[ 'Summary' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- Summary
-
- Type: RegexPatternSetSummary structure
High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a
RegexPatternSet
, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
CreateRuleGroup
$result = $client->createRuleGroup
([/* ... */]); $promise = $client->createRuleGroupAsync
([/* ... */]);
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.
Parameter Syntax
$result = $client->createRuleGroup([ 'Capacity' => <integer>, // REQUIRED 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', // REQUIRED 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED ], // ... ], 'Description' => '<string>', 'Name' => '<string>', // REQUIRED 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, // REQUIRED 'RuleLabels' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Statement' => [ // REQUIRED 'AndStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED 'Position' => 'FIRST|LAST|ANY', // REQUIRED ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', // REQUIRED 'Scope' => 'LABEL|NAMESPACE', // REQUIRED ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', // REQUIRED 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', // REQUIRED 'RequestInspection' => [ // REQUIRED 'AddressFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'PhoneNumberFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', // REQUIRED 'RequestInspection' => [ 'PasswordField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'UsernameField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], 'ScopeDownStatement' => [...], // RECURSIVE 'VendorName' => '<string>', // REQUIRED 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // REQUIRED, RECURSIVE ], 'OrStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', // REQUIRED 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', // REQUIRED ], 'QueryArgument' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], 'Limit' => <integer>, // REQUIRED 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'RegexString' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], ], 'SizeConstraintStatement' => [ 'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'Size' => <integer>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ]);
Parameter Details
Members
- Capacity
-
- Required: Yes
- Type: long (int|float)
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.
- CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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.
- Description
-
- Type: string
A description of the rule group that helps with identification.
- Name
-
- Required: Yes
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- Rules
-
- Type: Array of Rule structures
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.
- Scope
-
- Required: Yes
- Type: string
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.
- Tags
-
- Type: Array of Tag structures
An array of key:value pairs to associate with the resource.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Result Syntax
[ 'Summary' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- Summary
-
- Type: RuleGroupSummary structure
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.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFUnavailableEntityException:
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.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFSubscriptionNotFoundException:
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
CreateWebACL
$result = $client->createWebACL
([/* ... */]); $promise = $client->createWebACLAsync
([/* ... */]);
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 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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
Parameter Syntax
$result = $client->createWebACL([ 'AssociationConfig' => [ 'RequestBody' => [ '<AssociatedResourceType>' => [ 'DefaultSizeInspectionLimit' => 'KB_16|KB_32|KB_48|KB_64', // REQUIRED ], // ... ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', // REQUIRED 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED ], // ... ], 'DefaultAction' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Description' => '<string>', 'Name' => '<string>', // REQUIRED 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, // REQUIRED 'RuleLabels' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Statement' => [ // REQUIRED 'AndStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED 'Position' => 'FIRST|LAST|ANY', // REQUIRED ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', // REQUIRED 'Scope' => 'LABEL|NAMESPACE', // REQUIRED ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', // REQUIRED 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', // REQUIRED 'RequestInspection' => [ // REQUIRED 'AddressFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'PhoneNumberFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', // REQUIRED 'RequestInspection' => [ 'PasswordField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'UsernameField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], 'ScopeDownStatement' => [...], // RECURSIVE 'VendorName' => '<string>', // REQUIRED 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // REQUIRED, RECURSIVE ], 'OrStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', // REQUIRED 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', // REQUIRED ], 'QueryArgument' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], 'Limit' => <integer>, // REQUIRED 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'RegexString' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], ], 'SizeConstraintStatement' => [ 'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'Size' => <integer>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'Tags' => [ [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], 'TokenDomains' => ['<string>', ...], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ]);
Parameter Details
Members
- AssociationConfig
-
- Type: AssociationConfig structure
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 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).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
- CaptchaConfig
-
- Type: CaptchaConfig structure
Specifies how WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
. - ChallengeConfig
-
- Type: ChallengeConfig structure
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, WAF uses its default settings forChallengeConfig
. - CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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 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.
- DefaultAction
-
- Required: Yes
- Type: DefaultAction structure
The action to perform if none of the
Rules
contained in theWebACL
match. - Description
-
- Type: string
A description of the web ACL that helps with identification.
- Name
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Rules
-
- Type: Array of Rule structures
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.
- Scope
-
- Required: Yes
- Type: string
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.
- Tags
-
- Type: Array of Tag structures
An array of key:value pairs to associate with the resource.
- TokenDomains
-
- Type: Array of strings
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, 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. - VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Result Syntax
[ 'Summary' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], ]
Result Details
Members
- Summary
-
- Type: WebACLSummary structure
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.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
- WAFUnavailableEntityException:
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.
- WAFNonexistentItemException:
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.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFSubscriptionNotFoundException:
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
- WAFInvalidOperationException:
The operation isn't valid.
- 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
).- 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.
DeleteAPIKey
$result = $client->deleteAPIKey
([/* ... */]); $promise = $client->deleteAPIKeyAsync
([/* ... */]);
Deletes the specified API key.
After you delete a key, it can take up to 24 hours for WAF to disallow use of the key in all regions.
Parameter Syntax
$result = $client->deleteAPIKey([ 'APIKey' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- APIKey
-
- Required: Yes
- Type: string
The encrypted API key that you want to delete.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
DeleteFirewallManagerRuleGroups
$result = $client->deleteFirewallManagerRuleGroups
([/* ... */]); $promise = $client->deleteFirewallManagerRuleGroupsAsync
([/* ... */]);
Deletes all rule groups that are managed by Firewall Manager from the specified WebACL.
You can only use this if ManagedByFirewallManager
and RetrofittedByFirewallManager
are both false in the web ACL.
Parameter Syntax
$result = $client->deleteFirewallManagerRuleGroups([ 'WebACLArn' => '<string>', // REQUIRED 'WebACLLockToken' => '<string>', // REQUIRED ]);
Parameter Details
Members
- WebACLArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL.
- WebACLLockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
Result Syntax
[ 'NextWebACLLockToken' => '<string>', ]
Result Details
Members
- NextWebACLLockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
DeleteIPSet
$result = $client->deleteIPSet
([/* ... */]); $promise = $client->deleteIPSetAsync
([/* ... */]);
Deletes the specified IPSet.
Parameter Syntax
$result = $client->deleteIPSet([ 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFAssociatedItemException:
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
DeleteLoggingConfiguration
$result = $client->deleteLoggingConfiguration
([/* ... */]); $promise = $client->deleteLoggingConfigurationAsync
([/* ... */]);
Deletes the LoggingConfiguration from the specified web ACL.
Parameter Syntax
$result = $client->deleteLoggingConfiguration([ 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LogScope
-
- Type: string
The owner of the logging configuration, which must be set to
CUSTOMER
for the configurations that you manage.The log scope
SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.Default:
CUSTOMER
- LogType
-
- Type: string
Used to distinguish between various logging options. Currently, there is one option.
Default:
WAF_LOGS
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
DeletePermissionPolicy
$result = $client->deletePermissionPolicy
([/* ... */]); $promise = $client->deletePermissionPolicyAsync
([/* ... */]);
Permanently deletes an IAM policy from the specified rule group.
You must be the owner of the rule group to perform this operation.
Parameter Syntax
$result = $client->deletePermissionPolicy([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
Result Syntax
[]
Result Details
Errors
- WAFNonexistentItemException:
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.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
DeleteRegexPatternSet
$result = $client->deleteRegexPatternSet
([/* ... */]); $promise = $client->deleteRegexPatternSetAsync
([/* ... */]);
Deletes the specified RegexPatternSet.
Parameter Syntax
$result = $client->deleteRegexPatternSet([ 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the set. You cannot change the name after you create the set.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFAssociatedItemException:
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
DeleteRuleGroup
$result = $client->deleteRuleGroup
([/* ... */]); $promise = $client->deleteRuleGroupAsync
([/* ... */]);
Deletes the specified RuleGroup.
Parameter Syntax
$result = $client->deleteRuleGroup([ 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFAssociatedItemException:
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
DeleteWebACL
$result = $client->deleteWebACL
([/* ... */]); $promise = $client->deleteWebACLAsync
([/* ... */]);
Deletes the specified WebACL.
You can only use this if ManagedByFirewallManager
is false in the web ACL.
Before deleting any web ACL, first disassociate it from all resources.
-
To retrieve a list of the resources that are associated with a web ACL, use the following calls:
-
For regional resources, call ListResourcesForWebACL.
-
For Amazon CloudFront distributions, use the CloudFront call
ListDistributionsByWebACLId
. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
-
-
To disassociate a resource from a web ACL, use the following calls:
-
For regional resources, call DisassociateWebACL.
-
For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call
UpdateDistribution
. For information, see UpdateDistribution in the Amazon CloudFront API Reference.
-
Parameter Syntax
$result = $client->deleteWebACL([ 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFAssociatedItemException:
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
DescribeAllManagedProducts
$result = $client->describeAllManagedProducts
([/* ... */]); $promise = $client->describeAllManagedProductsAsync
([/* ... */]);
Provides high-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
Parameter Syntax
$result = $client->describeAllManagedProducts([ 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'ManagedProducts' => [ [ 'IsAdvancedManagedRuleSet' => true || false, 'IsVersioningSupported' => true || false, 'ManagedRuleSetName' => '<string>', 'ProductDescription' => '<string>', 'ProductId' => '<string>', 'ProductLink' => '<string>', 'ProductTitle' => '<string>', 'SnsTopicArn' => '<string>', 'VendorName' => '<string>', ], // ... ], ]
Result Details
Members
- ManagedProducts
-
- Type: Array of ManagedProductDescriptor structures
High-level information for the Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups.
Errors
- WAFInvalidOperationException:
The operation isn't valid.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
DescribeManagedProductsByVendor
$result = $client->describeManagedProductsByVendor
([/* ... */]); $promise = $client->describeManagedProductsByVendorAsync
([/* ... */]);
Provides high-level information for the managed rule groups owned by a specific vendor.
Parameter Syntax
$result = $client->describeManagedProductsByVendor([ 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VendorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Scope
-
- Required: Yes
- Type: string
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.
- VendorName
-
- Required: Yes
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
Result Syntax
[ 'ManagedProducts' => [ [ 'IsAdvancedManagedRuleSet' => true || false, 'IsVersioningSupported' => true || false, 'ManagedRuleSetName' => '<string>', 'ProductDescription' => '<string>', 'ProductId' => '<string>', 'ProductLink' => '<string>', 'ProductTitle' => '<string>', 'SnsTopicArn' => '<string>', 'VendorName' => '<string>', ], // ... ], ]
Result Details
Members
- ManagedProducts
-
- Type: Array of ManagedProductDescriptor structures
High-level information for the managed rule groups owned by the specified vendor.
Errors
- WAFInvalidOperationException:
The operation isn't valid.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
DescribeManagedRuleGroup
$result = $client->describeManagedRuleGroup
([/* ... */]); $promise = $client->describeManagedRuleGroupAsync
([/* ... */]);
Provides high-level information for a managed rule group, including descriptions of the rules.
Parameter Syntax
$result = $client->describeManagedRuleGroup([ 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VendorName' => '<string>', // REQUIRED 'VersionName' => '<string>', ]);
Parameter Details
Members
- Name
-
- Required: Yes
- Type: string
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- Scope
-
- Required: Yes
- Type: string
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.
- VendorName
-
- Required: Yes
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- VersionName
-
- Type: string
The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.
Result Syntax
[ 'AvailableLabels' => [ [ 'Name' => '<string>', ], // ... ], 'Capacity' => <integer>, 'ConsumedLabels' => [ [ 'Name' => '<string>', ], // ... ], 'LabelNamespace' => '<string>', 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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>', ], // ... ], 'SnsTopicArn' => '<string>', 'VersionName' => '<string>', ]
Result Details
Members
- AvailableLabels
-
- Type: Array of LabelSummary structures
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the
RuleLabels
for a Rule. - Capacity
-
- Type: long (int|float)
The web ACL capacity units (WCUs) required for this rule group.
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.
- ConsumedLabels
-
- Type: Array of LabelSummary structures
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a
LabelMatchStatement
specification, in the Statement definition of a rule. - LabelNamespace
-
- Type: string
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
-
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
: -
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- Rules
-
- Type: Array of RuleSummary structures
- SnsTopicArn
-
- Type: string
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
- VersionName
-
- Type: string
The managed rule group's version.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
- 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.
DisassociateWebACL
$result = $client->disassociateWebACL
([/* ... */]); $promise = $client->disassociateWebACLAsync
([/* ... */]);
Disassociates the specified regional application resource from any existing web ACL association. A resource can have at most one web ACL association. 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.
For Amazon CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution
. For information, see UpdateDistribution in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for DisassociateWebACL in the WAF Developer Guide.
Parameter Syntax
$result = $client->disassociateWebACL([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
-
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId
-
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
-
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
-
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GenerateMobileSdkReleaseUrl
$result = $client->generateMobileSdkReleaseUrl
([/* ... */]); $promise = $client->generateMobileSdkReleaseUrlAsync
([/* ... */]);
Generates a presigned download URL for the specified release of the mobile SDK.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
Parameter Syntax
$result = $client->generateMobileSdkReleaseUrl([ 'Platform' => 'IOS|ANDROID', // REQUIRED 'ReleaseVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Platform
-
- Required: Yes
- Type: string
The device platform.
- ReleaseVersion
-
- Required: Yes
- Type: string
The release version. For the latest available version, specify
LATEST
.
Result Syntax
[ 'Url' => '<string>', ]
Result Details
Members
- Url
-
- Type: string
The presigned download URL for the specified SDK release.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
GetDecryptedAPIKey
$result = $client->getDecryptedAPIKey
([/* ... */]); $promise = $client->getDecryptedAPIKeyAsync
([/* ... */]);
Returns your API key in decrypted form. Use this to check the token domains that you have defined for the key.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
Parameter Syntax
$result = $client->getDecryptedAPIKey([ 'APIKey' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- APIKey
-
- Required: Yes
- Type: string
The encrypted API key.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'CreationTimestamp' => <DateTime>, 'TokenDomains' => ['<string>', ...], ]
Result Details
Members
- CreationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the key was created.
- TokenDomains
-
- Type: Array of strings
The token domains that are defined in this API key.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
GetIPSet
$result = $client->getIPSet
([/* ... */]); $promise = $client->getIPSetAsync
([/* ... */]);
Retrieves the specified IPSet.
Parameter Syntax
$result = $client->getIPSet([ 'Id' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Required: Yes
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'IPSet' => [ 'ARN' => '<string>', 'Addresses' => ['<string>', ...], 'Description' => '<string>', 'IPAddressVersion' => 'IPV4|IPV6', 'Id' => '<string>', 'Name' => '<string>', ], 'LockToken' => '<string>', ]
Result Details
Members
- IPSet
-
- Type: IPSet structure
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GetLoggingConfiguration
$result = $client->getLoggingConfiguration
([/* ... */]); $promise = $client->getLoggingConfigurationAsync
([/* ... */]);
Returns the LoggingConfiguration for the specified web ACL.
Parameter Syntax
$result = $client->getLoggingConfiguration([ 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- LogScope
-
- Type: string
The owner of the logging configuration, which must be set to
CUSTOMER
for the configurations that you manage.The log scope
SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.Default:
CUSTOMER
- LogType
-
- Type: string
Used to distinguish between various logging options. Currently, there is one option.
Default:
WAF_LOGS
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
Result Syntax
[ 'LoggingConfiguration' => [ 'LogDestinationConfigs' => ['<string>', ...], 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'LoggingFilter' => [ 'DefaultBehavior' => 'KEEP|DROP', 'Filters' => [ [ 'Behavior' => 'KEEP|DROP', 'Conditions' => [ [ 'ActionCondition' => [ 'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT', ], 'LabelNameCondition' => [ 'LabelName' => '<string>', ], ], // ... ], 'Requirement' => 'MEETS_ALL|MEETS_ANY', ], // ... ], ], 'ManagedByFirewallManager' => true || false, 'RedactedFields' => [ [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], // ... ], 'ResourceArn' => '<string>', ], ]
Result Details
Members
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
The LoggingConfiguration for the specified web ACL.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
GetManagedRuleSet
$result = $client->getManagedRuleSet
([/* ... */]); $promise = $client->getManagedRuleSetAsync
([/* ... */]);
Retrieves the specified managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Parameter Syntax
$result = $client->getManagedRuleSet([ 'Id' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list
. You provide it to operations likeget
andupdate
. - Name
-
- Required: Yes
- Type: string
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'LockToken' => '<string>', 'ManagedRuleSet' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LabelNamespace' => '<string>', 'Name' => '<string>', 'PublishedVersions' => [ '<VersionKeyString>' => [ 'AssociatedRuleGroupArn' => '<string>', 'Capacity' => <integer>, 'ExpiryTimestamp' => <DateTime>, 'ForecastedLifetime' => <integer>, 'LastUpdateTimestamp' => <DateTime>, 'PublishTimestamp' => <DateTime>, ], // ... ], 'RecommendedVersion' => '<string>', ], ]
Result Details
Members
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - ManagedRuleSet
-
- Type: ManagedRuleSet structure
The managed rule set that you requested.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GetMobileSdkRelease
$result = $client->getMobileSdkRelease
([/* ... */]); $promise = $client->getMobileSdkReleaseAsync
([/* ... */]);
Retrieves information for the specified mobile SDK release, including release notes and tags.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
Parameter Syntax
$result = $client->getMobileSdkRelease([ 'Platform' => 'IOS|ANDROID', // REQUIRED 'ReleaseVersion' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Platform
-
- Required: Yes
- Type: string
The device platform.
- ReleaseVersion
-
- Required: Yes
- Type: string
The release version. For the latest available version, specify
LATEST
.
Result Syntax
[ 'MobileSdkRelease' => [ 'ReleaseNotes' => '<string>', 'ReleaseVersion' => '<string>', 'Tags' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], 'Timestamp' => <DateTime>, ], ]
Result Details
Members
- MobileSdkRelease
-
- Type: MobileSdkRelease structure
Information for a specified SDK release, including release notes and tags.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
GetPermissionPolicy
$result = $client->getPermissionPolicy
([/* ... */]); $promise = $client->getPermissionPolicyAsync
([/* ... */]);
Returns the IAM policy that is attached to the specified rule group.
You must be the owner of the rule group to perform this operation.
Parameter Syntax
$result = $client->getPermissionPolicy([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
Result Syntax
[ 'Policy' => '<string>', ]
Result Details
Members
- Policy
-
- Type: string
The IAM policy that is attached to the specified rule group.
Errors
- WAFNonexistentItemException:
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.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
GetRateBasedStatementManagedKeys
$result = $client->getRateBasedStatementManagedKeys
([/* ... */]); $promise = $client->getRateBasedStatementManagedKeysAsync
([/* ... */]);
Retrieves the IP addresses that are currently blocked by a rate-based rule instance. This is only available for rate-based rules that aggregate solely on the IP address or on the forwarded IP address.
The maximum number of addresses that can be blocked for a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.
For a rate-based rule that you've defined inside a rule group, provide the name of the rule group reference statement in your request, in addition to the rate-based rule name and the web ACL name.
WAF monitors web requests and manages keys independently for each unique combination of web ACL, optional rule group, and rate-based rule. For example, if you define a rate-based rule inside a rule group, and then use the rule group in a web ACL, WAF monitors web requests and manages keys for that web ACL, rule group reference statement, and rate-based rule instance. If you use the same rule group in a second web ACL, WAF monitors web requests and manages keys for this second usage completely independent of your first.
Parameter Syntax
$result = $client->getRateBasedStatementManagedKeys([ 'RuleGroupRuleName' => '<string>', 'RuleName' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'WebACLId' => '<string>', // REQUIRED 'WebACLName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- RuleGroupRuleName
-
- Type: string
The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.
- RuleName
-
- Required: Yes
- Type: string
The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're using in your web ACL, also provide the name of the rule group reference statement in the request parameter
RuleGroupRuleName
. - Scope
-
- Required: Yes
- Type: string
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.
- WebACLId
-
- Required: Yes
- Type: string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- WebACLName
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
Result Syntax
[ 'ManagedKeysIPV4' => [ 'Addresses' => ['<string>', ...], 'IPAddressVersion' => 'IPV4|IPV6', ], 'ManagedKeysIPV6' => [ 'Addresses' => ['<string>', ...], 'IPAddressVersion' => 'IPV4|IPV6', ], ]
Result Details
Members
- ManagedKeysIPV4
-
- Type: RateBasedStatementManagedKeysIPSet structure
The keys that are of Internet Protocol version 4 (IPv4).
- ManagedKeysIPV6
-
- Type: RateBasedStatementManagedKeysIPSet structure
The keys that are of Internet Protocol version 6 (IPv6).
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
- WAFUnsupportedAggregateKeyTypeException:
The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an
AggregateKeyType
setting ofIP
orFORWARDED_IP
.
GetRegexPatternSet
$result = $client->getRegexPatternSet
([/* ... */]); $promise = $client->getRegexPatternSetAsync
([/* ... */]);
Retrieves the specified RegexPatternSet.
Parameter Syntax
$result = $client->getRegexPatternSet([ 'Id' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Required: Yes
- Type: string
The name of the set. You cannot change the name after you create the set.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'LockToken' => '<string>', 'RegexPatternSet' => [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'Name' => '<string>', 'RegularExpressionList' => [ [ 'RegexString' => '<string>', ], // ... ], ], ]
Result Details
Members
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - RegexPatternSet
-
- Type: RegexPatternSet structure
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GetRuleGroup
$result = $client->getRuleGroup
([/* ... */]); $promise = $client->getRuleGroupAsync
([/* ... */]);
Retrieves the specified RuleGroup.
Parameter Syntax
$result = $client->getRuleGroup([ 'ARN' => '<string>', 'Id' => '<string>', 'Name' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', ]);
Parameter Details
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Id
-
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- Scope
-
- Type: string
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.
Result Syntax
[ 'LockToken' => '<string>', 'RuleGroup' => [ 'ARN' => '<string>', 'AvailableLabels' => [ [ 'Name' => '<string>', ], // ... ], 'Capacity' => <integer>, 'ConsumedLabels' => [ [ 'Name' => '<string>', ], // ... ], 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', ], // ... ], 'Description' => '<string>', 'Id' => '<string>', 'LabelNamespace' => '<string>', 'Name' => '<string>', 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => <integer>, ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'RuleLabels' => [ [ 'Name' => '<string>', ], // ... ], 'Statement' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [...], // RECURSIVE 'VendorName' => '<string>', 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], ]
Result Details
Members
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - RuleGroup
-
- Type: RuleGroup structure
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GetSampledRequests
$result = $client->getSampledRequests
([/* ... */]); $promise = $client->getSampledRequestsAsync
([/* ... */]);
Gets detailed information about a specified number of requests--a sample--that WAF randomly selects from among the first 5,000 requests that your Amazon Web Services resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.
GetSampledRequests
returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests
returns an updated time range. This new time range indicates the actual period during which WAF selected the requests in the sample.
Parameter Syntax
$result = $client->getSampledRequests([ 'MaxItems' => <integer>, // REQUIRED 'RuleMetricName' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'TimeWindow' => [ // REQUIRED 'EndTime' => <integer || string || DateTime>, // REQUIRED 'StartTime' => <integer || string || DateTime>, // REQUIRED ], 'WebAclArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- MaxItems
-
- Required: Yes
- Type: long (int|float)
The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web Services resource received during the time range. If your resource received fewer requests than the value of
MaxItems
,GetSampledRequests
returns information about all of them. - RuleMetricName
-
- Required: Yes
- Type: string
The metric name assigned to the
Rule
orRuleGroup
dimension for which you want a sample of requests. - Scope
-
- Required: Yes
- Type: string
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.
- TimeWindow
-
- Required: Yes
- Type: TimeWindow structure
The start date and time and the end date and time of the range for which you want
GetSampledRequests
to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator,Z
. For example,"2016-09-27T14:50Z"
. You can specify any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF sets it to three hours ago. - WebAclArn
-
- Required: Yes
- Type: string
The Amazon resource name (ARN) of the
WebACL
for which you want a sample of requests.
Result Syntax
[ 'PopulationSize' => <integer>, 'SampledRequests' => [ [ 'Action' => '<string>', 'CaptchaResponse' => [ 'FailureReason' => 'TOKEN_MISSING|TOKEN_EXPIRED|TOKEN_INVALID|TOKEN_DOMAIN_MISMATCH', 'ResponseCode' => <integer>, 'SolveTimestamp' => <integer>, ], 'ChallengeResponse' => [ 'FailureReason' => 'TOKEN_MISSING|TOKEN_EXPIRED|TOKEN_INVALID|TOKEN_DOMAIN_MISMATCH', 'ResponseCode' => <integer>, 'SolveTimestamp' => <integer>, ], 'Labels' => [ [ 'Name' => '<string>', ], // ... ], 'OverriddenAction' => '<string>', 'Request' => [ 'ClientIP' => '<string>', 'Country' => '<string>', 'HTTPVersion' => '<string>', 'Headers' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'Method' => '<string>', 'URI' => '<string>', ], 'RequestHeadersInserted' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], 'ResponseCodeSent' => <integer>, 'RuleNameWithinRuleGroup' => '<string>', 'Timestamp' => <DateTime>, 'Weight' => <integer>, ], // ... ], 'TimeWindow' => [ 'EndTime' => <DateTime>, 'StartTime' => <DateTime>, ], ]
Result Details
Members
- PopulationSize
-
- Type: long (int|float)
The total number of requests from which
GetSampledRequests
got a sample ofMaxItems
requests. IfPopulationSize
is less thanMaxItems
, the sample includes every request that your Amazon Web Services resource received during the specified time range. - SampledRequests
-
- Type: Array of SampledHTTPRequest structures
A complex type that contains detailed information about each of the requests in the sample.
- TimeWindow
-
- Type: TimeWindow structure
Usually,
TimeWindow
is the time range that you specified in theGetSampledRequests
request. However, if your Amazon Web Services resource received more than 5,000 requests during the time range that you specified in the request,GetSampledRequests
returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.
Errors
- WAFNonexistentItemException:
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.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
GetWebACL
$result = $client->getWebACL
([/* ... */]); $promise = $client->getWebACLAsync
([/* ... */]);
Retrieves the specified WebACL.
Parameter Syntax
$result = $client->getWebACL([ 'Id' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'ApplicationIntegrationURL' => '<string>', 'LockToken' => '<string>', 'WebACL' => [ 'ARN' => '<string>', 'AssociationConfig' => [ 'RequestBody' => [ '<AssociatedResourceType>' => [ 'DefaultSizeInspectionLimit' => 'KB_16|KB_32|KB_48|KB_64', ], // ... ], ], 'Capacity' => <integer>, 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', ], // ... ], 'DefaultAction' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, 'ResponseHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], ], 'Description' => '<string>', 'Id' => '<string>', 'LabelNamespace' => '<string>', 'ManagedByFirewallManager' => true || false, 'Name' => '<string>', 'PostProcessFirewallManagerRuleGroups' => [ [ 'FirewallManagerStatement' => [ 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [...], // RECURSIVE 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VendorName' => '<string>', 'Version' => '<string>', ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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>', ], // ... ], ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'PreProcessFirewallManagerRuleGroups' => [ [ 'FirewallManagerStatement' => [ 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [...], // RECURSIVE 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VendorName' => '<string>', 'Version' => '<string>', ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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>', ], // ... ], ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'RetrofittedByFirewallManager' => true || false, 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => <integer>, ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'RuleLabels' => [ [ 'Name' => '<string>', ], // ... ], 'Statement' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [...], // RECURSIVE 'VendorName' => '<string>', 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'TokenDomains' => ['<string>', ...], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], ]
Result Details
Members
- ApplicationIntegrationURL
-
- Type: string
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the integration SDKs with the account takeover prevention managed rule group
AWSManagedRulesATPRuleSet
and the account creation fraud prevention managed rule groupAWSManagedRulesACFPRuleSet
. This is only populated if you are using a rule group in your web ACL that integrates with your applications in this way. For more information, see WAF client application integration in the WAF Developer Guide. - LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - WebACL
-
- Type: WebACL structure
The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
GetWebACLForResource
$result = $client->getWebACLForResource
([/* ... */]); $promise = $client->getWebACLForResourceAsync
([/* ... */]);
Retrieves the WebACL for the specified resource.
This call uses GetWebACL
, to verify that your account has permission to access the retrieved web ACL. If you get an error that indicates that your account isn't authorized to perform wafv2:GetWebACL
on the resource, that error won't be included in your CloudTrail event history.
For Amazon CloudFront, don't use this call. Instead, call the CloudFront action GetDistributionConfig
. For information, see GetDistributionConfig in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for GetWebACLForResource in the WAF Developer Guide.
Parameter Syntax
$result = $client->getWebACLForResource([ 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
The ARN must be in one of the following formats:
-
For an Application Load Balancer:
arn:partition:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
-
For an Amazon API Gateway REST API:
arn:partition:apigateway:region::/restapis/api-id/stages/stage-name
-
For an AppSync GraphQL API:
arn:partition:appsync:region:account-id:apis/GraphQLApiId
-
For an Amazon Cognito user pool:
arn:partition:cognito-idp:region:account-id:userpool/user-pool-id
-
For an App Runner service:
arn:partition:apprunner:region:account-id:service/apprunner-service-name/apprunner-service-id
-
For an Amazon Web Services Verified Access instance:
arn:partition:ec2:region:account-id:verified-access-instance/instance-id
Result Syntax
[ 'WebACL' => [ 'ARN' => '<string>', 'AssociationConfig' => [ 'RequestBody' => [ '<AssociatedResourceType>' => [ 'DefaultSizeInspectionLimit' => 'KB_16|KB_32|KB_48|KB_64', ], // ... ], ], 'Capacity' => <integer>, 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', ], // ... ], 'DefaultAction' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, 'ResponseHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], ], 'Description' => '<string>', 'Id' => '<string>', 'LabelNamespace' => '<string>', 'ManagedByFirewallManager' => true || false, 'Name' => '<string>', 'PostProcessFirewallManagerRuleGroups' => [ [ 'FirewallManagerStatement' => [ 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [...], // RECURSIVE 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VendorName' => '<string>', 'Version' => '<string>', ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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>', ], // ... ], ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'PreProcessFirewallManagerRuleGroups' => [ [ 'FirewallManagerStatement' => [ 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [...], // RECURSIVE 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VendorName' => '<string>', 'Version' => '<string>', ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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>', ], // ... ], ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'RetrofittedByFirewallManager' => true || false, 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => <integer>, ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, ], ], 'Name' => '<string>', 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, 'RuleLabels' => [ [ 'Name' => '<string>', ], // ... ], 'Statement' => [ 'AndStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', 'Position' => 'FIRST|LAST|ANY', ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', 'Scope' => 'LABEL|NAMESPACE', ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', 'RequestInspection' => [ 'AddressFields' => [ [ 'Identifier' => '<string>', ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', ], 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', 'RequestInspection' => [ 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', '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' => [<integer>, ...], 'SuccessCodes' => [<integer>, ...], ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', ], ], // ... ], 'Name' => '<string>', 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => [...], // RECURSIVE 'VendorName' => '<string>', 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // RECURSIVE ], 'OrStatement' => [ 'Statements' => [ [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', ], 'QueryArgument' => [ 'Name' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', 'HeaderName' => '<string>', ], 'Limit' => <integer>, 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'RegexString' => '<string>', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', 'ExcludedRules' => [ [ 'Name' => '<string>', ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ [ 'Name' => '<string>', 'Value' => '<string>', ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, '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' => 'EQ|NE|LE|LT|GE|GT', 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'Size' => <integer>, 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], 'TextTransformations' => [ [ 'Priority' => <integer>, 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', ], // ... ], ], ], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], // ... ], 'TokenDomains' => ['<string>', ...], 'VisibilityConfig' => [ 'CloudWatchMetricsEnabled' => true || false, 'MetricName' => '<string>', 'SampledRequestsEnabled' => true || false, ], ], ]
Result Details
Members
- WebACL
-
- Type: WebACL structure
The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFUnavailableEntityException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
ListAPIKeys
$result = $client->listAPIKeys
([/* ... */]); $promise = $client->listAPIKeysAsync
([/* ... */]);
Retrieves a list of the API keys that you've defined for the specified scope.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
Parameter Syntax
$result = $client->listAPIKeys([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'APIKeySummaries' => [ [ 'APIKey' => '<string>', 'CreationTimestamp' => <DateTime>, 'TokenDomains' => ['<string>', ...], 'Version' => <integer>, ], // ... ], 'ApplicationIntegrationURL' => '<string>', 'NextMarker' => '<string>', ]
Result Details
Members
- APIKeySummaries
-
- Type: Array of APIKeySummary structures
The array of key summaries. If you specified a
Limit
in your request, this might not be the full list. - ApplicationIntegrationURL
-
- Type: string
The CAPTCHA application integration URL, for use in your JavaScript implementation.
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
ListAvailableManagedRuleGroupVersions
$result = $client->listAvailableManagedRuleGroupVersions
([/* ... */]); $promise = $client->listAvailableManagedRuleGroupVersionsAsync
([/* ... */]);
Returns a list of the available versions for the specified managed rule group.
Parameter Syntax
$result = $client->listAvailableManagedRuleGroupVersions([ 'Limit' => <integer>, 'Name' => '<string>', // REQUIRED 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VendorName' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - Name
-
- Required: Yes
- Type: string
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
- VendorName
-
- Required: Yes
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
Result Syntax
[ 'CurrentDefaultVersion' => '<string>', 'NextMarker' => '<string>', 'Versions' => [ [ 'LastUpdateTimestamp' => <DateTime>, 'Name' => '<string>', ], // ... ], ]
Result Details
Members
- CurrentDefaultVersion
-
- Type: string
The name of the version that's currently set as the default.
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Versions
-
- Type: Array of ManagedRuleGroupVersion structures
The versions that are currently available for the specified managed rule group. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
ListAvailableManagedRuleGroups
$result = $client->listAvailableManagedRuleGroups
([/* ... */]); $promise = $client->listAvailableManagedRuleGroupsAsync
([/* ... */]);
Retrieves an array of managed rule groups that are available for you to use. This list includes all Amazon Web Services Managed Rules rule groups and all of the Amazon Web Services Marketplace managed rule groups that you're subscribed to.
Parameter Syntax
$result = $client->listAvailableManagedRuleGroups([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'ManagedRuleGroups' => [ [ 'Description' => '<string>', 'Name' => '<string>', 'VendorName' => '<string>', 'VersioningSupported' => true || false, ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- ManagedRuleGroups
-
- Type: Array of ManagedRuleGroupSummary structures
Array of managed rule groups that you can use. If you specified a
Limit
in your request, this might not be the full list. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListIPSets
$result = $client->listIPSets
([/* ... */]); $promise = $client->listIPSetsAsync
([/* ... */]);
Retrieves an array of IPSetSummary objects for the IP sets that you manage.
Parameter Syntax
$result = $client->listIPSets([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'IPSets' => [ [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- IPSets
-
- Type: Array of IPSetSummary structures
Array of IPSets. If you specified a
Limit
in your request, this might not be the full list. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListLoggingConfigurations
$result = $client->listLoggingConfigurations
([/* ... */]); $promise = $client->listLoggingConfigurationsAsync
([/* ... */]);
Retrieves an array of your LoggingConfiguration objects.
Parameter Syntax
$result = $client->listLoggingConfigurations([ 'Limit' => <integer>, 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - LogScope
-
- Type: string
The owner of the logging configuration, which must be set to
CUSTOMER
for the configurations that you manage.The log scope
SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.Default:
CUSTOMER
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'LoggingConfigurations' => [ [ 'LogDestinationConfigs' => ['<string>', ...], 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'LoggingFilter' => [ 'DefaultBehavior' => 'KEEP|DROP', 'Filters' => [ [ 'Behavior' => 'KEEP|DROP', 'Conditions' => [ [ 'ActionCondition' => [ 'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT', ], 'LabelNameCondition' => [ 'LabelName' => '<string>', ], ], // ... ], 'Requirement' => 'MEETS_ALL|MEETS_ANY', ], // ... ], ], 'ManagedByFirewallManager' => true || false, 'RedactedFields' => [ [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], // ... ], 'ResourceArn' => '<string>', ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- LoggingConfigurations
-
- Type: Array of LoggingConfiguration structures
Array of logging configurations. If you specified a
Limit
in your request, this might not be the full list. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListManagedRuleSets
$result = $client->listManagedRuleSets
([/* ... */]); $promise = $client->listManagedRuleSetsAsync
([/* ... */]);
Retrieves the managed rule sets that you own.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Parameter Syntax
$result = $client->listManagedRuleSets([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'ManagedRuleSets' => [ [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LabelNamespace' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], // ... ], 'NextMarker' => '<string>', ]
Result Details
Members
- ManagedRuleSets
-
- Type: Array of ManagedRuleSetSummary structures
Your managed rule sets. If you specified a
Limit
in your request, this might not be the full list. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListMobileSdkReleases
$result = $client->listMobileSdkReleases
([/* ... */]); $promise = $client->listMobileSdkReleasesAsync
([/* ... */]);
Retrieves a list of the available releases for the mobile SDK and the specified device platform.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
Parameter Syntax
$result = $client->listMobileSdkReleases([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Platform' => 'IOS|ANDROID', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Platform
-
- Required: Yes
- Type: string
The device platform to retrieve the list for.
Result Syntax
[ 'NextMarker' => '<string>', 'ReleaseSummaries' => [ [ 'ReleaseVersion' => '<string>', 'Timestamp' => <DateTime>, ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - ReleaseSummaries
-
- Type: Array of ReleaseSummary structures
The high level information for the available SDK releases. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListRegexPatternSets
$result = $client->listRegexPatternSets
([/* ... */]); $promise = $client->listRegexPatternSetsAsync
([/* ... */]);
Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.
Parameter Syntax
$result = $client->listRegexPatternSets([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextMarker' => '<string>', 'RegexPatternSets' => [ [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - RegexPatternSets
-
- Type: Array of RegexPatternSetSummary structures
Array of regex pattern sets. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListResourcesForWebACL
$result = $client->listResourcesForWebACL
([/* ... */]); $promise = $client->listResourcesForWebACLAsync
([/* ... */]);
Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL.
For Amazon CloudFront, don't use this call. Instead, use the CloudFront call ListDistributionsByWebACLId
. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.
Required permissions for customer-managed IAM policies
This call requires permissions that are specific to the protected resource type. For details, see Permissions for ListResourcesForWebACL in the WAF Developer Guide.
Parameter Syntax
$result = $client->listResourcesForWebACL([ 'ResourceType' => 'APPLICATION_LOAD_BALANCER|API_GATEWAY|APPSYNC|COGNITO_USER_POOL|APP_RUNNER_SERVICE|VERIFIED_ACCESS_INSTANCE', 'WebACLArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ResourceType
-
- Type: string
Used for web ACLs that are scoped for regional applications. 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.
If you don't provide a resource type, the call uses the resource type
APPLICATION_LOAD_BALANCER
.Default:
APPLICATION_LOAD_BALANCER
- WebACLArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL.
Result Syntax
[ 'ResourceArns' => ['<string>', ...], ]
Result Details
Members
- ResourceArns
-
- Type: Array of strings
The array of Amazon Resource Names (ARNs) of the associated resources.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListRuleGroups
$result = $client->listRuleGroups
([/* ... */]); $promise = $client->listRuleGroupsAsync
([/* ... */]);
Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.
Parameter Syntax
$result = $client->listRuleGroups([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextMarker' => '<string>', 'RuleGroups' => [ [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - RuleGroups
-
- Type: Array of RuleGroupSummary structures
Array of rule groups. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
ListTagsForResource
$result = $client->listTagsForResource
([/* ... */]); $promise = $client->listTagsForResourceAsync
([/* ... */]);
Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
Parameter Syntax
$result = $client->listTagsForResource([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'ResourceARN' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
Result Syntax
[ 'NextMarker' => '<string>', 'TagInfoForResource' => [ 'ResourceARN' => '<string>', 'TagList' => [ [ 'Key' => '<string>', 'Value' => '<string>', ], // ... ], ], ]
Result Details
Members
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - TagInfoForResource
-
- Type: TagInfoForResource structure
The collection of tagging definitions for the resource. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
ListWebACLs
$result = $client->listWebACLs
([/* ... */]); $promise = $client->listWebACLsAsync
([/* ... */]);
Retrieves an array of WebACLSummary objects for the web ACLs that you manage.
Parameter Syntax
$result = $client->listWebACLs([ 'Limit' => <integer>, 'NextMarker' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Limit
-
- Type: int
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the response, WAF provides a
NextMarker
value that you can use in a subsequent call to get the next batch of objects. - NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextMarker' => '<string>', 'WebACLs' => [ [ 'ARN' => '<string>', 'Description' => '<string>', 'Id' => '<string>', 'LockToken' => '<string>', 'Name' => '<string>', ], // ... ], ]
Result Details
Members
- NextMarker
-
- Type: string
When you request a list of objects with a
Limit
setting, if the number of objects that are still available for retrieval exceeds the limit, WAF returns aNextMarker
value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request. - WebACLs
-
- Type: Array of WebACLSummary structures
Array of web ACLs. If you specified a
Limit
in your request, this might not be the full list.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
PutLoggingConfiguration
$result = $client->putLoggingConfiguration
([/* ... */]); $promise = $client->putLoggingConfigurationAsync
([/* ... */]);
Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.
This operation completely replaces any mutable specifications that you already have for a logging configuration with the ones that you provide to this call.
To modify an existing logging configuration, do the following:
-
Retrieve it by calling GetLoggingConfiguration
-
Update its settings as needed
-
Provide the complete logging configuration specification to this call
You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following steps:
-
Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
The name that you give the destination must start with
aws-waf-logs-
. Depending on the type of destination, you might need to configure additional settings or permissions.For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
-
Associate your logging destination to your web ACL using a
PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
Parameter Syntax
$result = $client->putLoggingConfiguration([ 'LoggingConfiguration' => [ // REQUIRED 'LogDestinationConfigs' => ['<string>', ...], // REQUIRED 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'LoggingFilter' => [ 'DefaultBehavior' => 'KEEP|DROP', // REQUIRED 'Filters' => [ // REQUIRED [ 'Behavior' => 'KEEP|DROP', // REQUIRED 'Conditions' => [ // REQUIRED [ 'ActionCondition' => [ 'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT', // REQUIRED ], 'LabelNameCondition' => [ 'LabelName' => '<string>', // REQUIRED ], ], // ... ], 'Requirement' => 'MEETS_ALL|MEETS_ANY', // REQUIRED ], // ... ], ], 'ManagedByFirewallManager' => true || false, 'RedactedFields' => [ [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], // ... ], 'ResourceArn' => '<string>', // REQUIRED ], ]);
Parameter Details
Members
- LoggingConfiguration
-
- Required: Yes
- Type: LoggingConfiguration structure
Result Syntax
[ 'LoggingConfiguration' => [ 'LogDestinationConfigs' => ['<string>', ...], 'LogScope' => 'CUSTOMER|SECURITY_LAKE', 'LogType' => 'WAF_LOGS', 'LoggingFilter' => [ 'DefaultBehavior' => 'KEEP|DROP', 'Filters' => [ [ 'Behavior' => 'KEEP|DROP', 'Conditions' => [ [ 'ActionCondition' => [ 'Action' => 'ALLOW|BLOCK|COUNT|CAPTCHA|CHALLENGE|EXCLUDED_AS_COUNT', ], 'LabelNameCondition' => [ 'LabelName' => '<string>', ], ], // ... ], 'Requirement' => 'MEETS_ALL|MEETS_ANY', ], // ... ], ], 'ManagedByFirewallManager' => true || false, 'RedactedFields' => [ [ 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Headers' => [ 'MatchPattern' => [ 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', ], 'SingleQueryArgument' => [ 'Name' => '<string>', ], 'UriPath' => [ ], ], // ... ], 'ResourceArn' => '<string>', ], ]
Result Details
Members
- LoggingConfiguration
-
- Type: LoggingConfiguration structure
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFServiceLinkedRoleErrorException:
WAF is not able to access the service linked role. This can be caused by a previous
PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previousDeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made a call toDeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidOperationException:
The operation isn't valid.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFLogDestinationPermissionIssueException:
The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the WAF Developer Guide.
PutManagedRuleSetVersions
$result = $client->putManagedRuleSetVersions
([/* ... */]); $promise = $client->putManagedRuleSetVersionsAsync
([/* ... */]);
Defines the versions of your managed rule set that you are offering to the customers. Customers see your offerings as managed rule groups with versioning.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Customers retrieve their managed rule group list by calling ListAvailableManagedRuleGroups. The name that you provide here for your managed rule set is the name the customer sees for the corresponding managed rule group. Customers can retrieve the available versions for a managed rule group by calling ListAvailableManagedRuleGroupVersions. You provide a rule group specification for each version. For each managed rule set, you must specify a version that you recommend using.
To initiate the expiration of a managed rule group version, use UpdateManagedRuleSetVersionExpiryDate.
Parameter Syntax
$result = $client->putManagedRuleSetVersions([ 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'RecommendedVersion' => '<string>', 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VersionsToPublish' => [ '<VersionKeyString>' => [ 'AssociatedRuleGroupArn' => '<string>', 'ForecastedLifetime' => <integer>, ], // ... ], ]);
Parameter Details
Members
- Id
-
- Required: Yes
- Type: string
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list
. You provide it to operations likeget
andupdate
. - LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
- RecommendedVersion
-
- Type: string
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
- Scope
-
- Required: Yes
- Type: string
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.
- VersionsToPublish
-
- Type: Associative array of custom strings keys (VersionKeyString) to VersionToPublish structures
The versions of the named managed rule group that you want to offer to your customers.
Result Syntax
[ 'NextLockToken' => '<string>', ]
Result Details
Members
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
PutPermissionPolicy
$result = $client->putPermissionPolicy
([/* ... */]); $promise = $client->putPermissionPolicyAsync
([/* ... */]);
Use this to share a rule group with other accounts.
This action attaches an IAM policy to the specified resource. You must be the owner of the rule group to perform this operation.
This action is subject to the following restrictions:
-
You can attach only one policy with each
PutPermissionPolicy
request. -
The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same Region.
-
The user making the request must be the owner of the rule group.
If a rule group has been shared with your account, you can access it through the call GetRuleGroup
, and you can reference it in CreateWebACL
and UpdateWebACL
. Rule groups that are shared with you don't appear in your WAF console rule groups listing.
Parameter Syntax
$result = $client->putPermissionPolicy([ 'Policy' => '<string>', // REQUIRED 'ResourceArn' => '<string>', // REQUIRED ]);
Parameter Details
Members
- Policy
-
- Required: Yes
- Type: string
The policy to attach to the specified rule group.
The policy specifications must conform to the following:
-
The policy must be composed using IAM Policy version 2012-10-17.
-
The policy must include specifications for
Effect
,Action
, andPrincipal
. -
Effect
must specifyAllow
. -
Action
must specifywafv2:CreateWebACL
,wafv2:UpdateWebACL
, andwafv2:PutFirewallManagerRuleGroups
and may optionally specifywafv2:GetRuleGroup
. WAF rejects any extra actions or wildcard actions in the policy. -
The policy must not include a
Resource
parameter.
For more information, see IAM Policies.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
Result Syntax
[]
Result Details
Errors
- WAFNonexistentItemException:
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.
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFInvalidPermissionPolicyException:
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
-
The policy must be composed using IAM Policy version 2012-10-17.
-
The policy must include specifications for
Effect
,Action
, andPrincipal
. -
Effect
must specifyAllow
. -
Action
must specifywafv2:CreateWebACL
,wafv2:UpdateWebACL
, andwafv2:PutFirewallManagerRuleGroups
and may optionally specifywafv2:GetRuleGroup
. WAF rejects any extra actions or wildcard actions in the policy. -
The policy must not include a
Resource
parameter.
For more information, see IAM Policies.
-
TagResource
$result = $client->tagResource
([/* ... */]); $promise = $client->tagResourceAsync
([/* ... */]);
Associates tags with the specified Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
Parameter Syntax
$result = $client->tagResource([ 'ResourceARN' => '<string>', // REQUIRED 'Tags' => [ // REQUIRED [ 'Key' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- Tags
-
- Required: Yes
- Type: Array of Tag structures
An array of key:value pairs to associate with the resource.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFNonexistentItemException:
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.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
UntagResource
$result = $client->untagResource
([/* ... */]); $promise = $client->untagResourceAsync
([/* ... */]);
Disassociates tags from an Amazon Web Services resource. Tags are key:value pairs that you can associate with Amazon Web Services resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each Amazon Web Services resource.
Parameter Syntax
$result = $client->untagResource([ 'ResourceARN' => '<string>', // REQUIRED 'TagKeys' => ['<string>', ...], // REQUIRED ]);
Parameter Details
Members
- ResourceARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the resource.
- TagKeys
-
- Required: Yes
- Type: Array of strings
An array of keys identifying the tags to disassociate from the resource.
Result Syntax
[]
Result Details
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFTagOperationException:
An error occurred during the tagging operation. Retry your request.
- WAFTagOperationInternalErrorException:
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
- WAFInvalidOperationException:
The operation isn't valid.
UpdateIPSet
$result = $client->updateIPSet
([/* ... */]); $promise = $client->updateIPSetAsync
([/* ... */]);
Updates the specified IPSet.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
To modify an IP set, do the following:
-
Retrieve it by calling GetIPSet
-
Update its settings as needed
-
Provide the complete IP set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Parameter Syntax
$result = $client->updateIPSet([ 'Addresses' => ['<string>', ...], // REQUIRED 'Description' => '<string>', 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Addresses
-
- Required: Yes
- Type: Array of strings
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for
/0
.Example address strings:
-
For requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32
. -
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
. -
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON
Addresses
specifications:-
Empty array:
"Addresses": []
-
Array with one address:
"Addresses": ["192.0.2.44/32"]
-
Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
-
INVALID specification:
"Addresses": [""]
INVALID
- Description
-
- Type: string
A description of the IP set that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it. - Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextLockToken' => '<string>', ]
Result Details
Members
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns this token to your
update
requests. You useNextLockToken
in the same manner as you useLockToken
.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFInvalidOperationException:
The operation isn't valid.
UpdateManagedRuleSetVersionExpiryDate
$result = $client->updateManagedRuleSetVersionExpiryDate
([/* ... */]); $promise = $client->updateManagedRuleSetVersionExpiryDateAsync
([/* ... */]);
Updates the expiration information for your managed rule set. Use this to initiate the expiration of a managed rule group version. After you initiate expiration for a version, WAF excludes it from the response to ListAvailableManagedRuleGroupVersions for the managed rule group.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Parameter Syntax
$result = $client->updateManagedRuleSetVersionExpiryDate([ 'ExpiryTimestamp' => <integer || string || DateTime>, // REQUIRED 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VersionToExpire' => '<string>', // REQUIRED ]);
Parameter Details
Members
- ExpiryTimestamp
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
- Id
-
- Required: Yes
- Type: string
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list
. You provide it to operations likeget
andupdate
. - LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
- Scope
-
- Required: Yes
- Type: string
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.
- VersionToExpire
-
- Required: Yes
- Type: string
The version that you want to remove from your list of offerings for the named managed rule group.
Result Syntax
[ 'ExpiringVersion' => '<string>', 'ExpiryTimestamp' => <DateTime>, 'NextLockToken' => '<string>', ]
Result Details
Members
- ExpiringVersion
-
- Type: string
The version that is set to expire.
- ExpiryTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFOptimisticLockException:
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.
- WAFInvalidOperationException:
The operation isn't valid.
UpdateRegexPatternSet
$result = $client->updateRegexPatternSet
([/* ... */]); $promise = $client->updateRegexPatternSetAsync
([/* ... */]);
Updates the specified RegexPatternSet.
This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call.
To modify a regex pattern set, do the following:
-
Retrieve it by calling GetRegexPatternSet
-
Update its settings as needed
-
Provide the complete regex pattern set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Parameter Syntax
$result = $client->updateRegexPatternSet([ 'Description' => '<string>', 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'RegularExpressionList' => [ // REQUIRED [ 'RegexString' => '<string>', ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED ]);
Parameter Details
Members
- Description
-
- Type: string
A description of the set that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the set. You cannot change the name after you create the set.
- RegularExpressionList
-
- Required: Yes
- Type: Array of Regex structures
- Scope
-
- Required: Yes
- Type: string
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.
Result Syntax
[ 'NextLockToken' => '<string>', ]
Result Details
Members
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns this token to your
update
requests. You useNextLockToken
in the same manner as you useLockToken
.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFInvalidOperationException:
The operation isn't valid.
UpdateRuleGroup
$result = $client->updateRuleGroup
([/* ... */]); $promise = $client->updateRuleGroupAsync
([/* ... */]);
Updates the specified RuleGroup.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call.
To modify a rule group, do the following:
-
Retrieve it by calling GetRuleGroup
-
Update its settings as needed
-
Provide the complete rule group specification to this call
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.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Parameter Syntax
$result = $client->updateRuleGroup([ 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', // REQUIRED 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED ], // ... ], 'Description' => '<string>', 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, // REQUIRED 'RuleLabels' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Statement' => [ // REQUIRED 'AndStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED 'Position' => 'FIRST|LAST|ANY', // REQUIRED ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', // REQUIRED 'Scope' => 'LABEL|NAMESPACE', // REQUIRED ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', // REQUIRED 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', // REQUIRED 'RequestInspection' => [ // REQUIRED 'AddressFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'PhoneNumberFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', // REQUIRED 'RequestInspection' => [ 'PasswordField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'UsernameField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], 'ScopeDownStatement' => [...], // RECURSIVE 'VendorName' => '<string>', // REQUIRED 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // REQUIRED, RECURSIVE ], 'OrStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', // REQUIRED 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', // REQUIRED ], 'QueryArgument' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], 'Limit' => <integer>, // REQUIRED 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'RegexString' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], ], 'SizeConstraintStatement' => [ 'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'Size' => <integer>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ]);
Parameter Details
Members
- CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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.
- Description
-
- Type: string
A description of the rule group that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- Rules
-
- Type: Array of Rule structures
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.
- Scope
-
- Required: Yes
- Type: string
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.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Result Syntax
[ 'NextLockToken' => '<string>', ]
Result Details
Members
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns this token to your
update
requests. You useNextLockToken
in the same manner as you useLockToken
.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFUnavailableEntityException:
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.
- WAFSubscriptionNotFoundException:
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
- WAFInvalidOperationException:
The operation isn't valid.
- 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
).
UpdateWebACL
$result = $client->updateWebACL
([/* ... */]); $promise = $client->updateWebACLAsync
([/* ... */]);
Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.
This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call.
To modify a web ACL, do the following:
-
Retrieve it by calling GetWebACL
-
Update its settings as needed
-
Provide the complete web ACL specification to this call
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 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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Parameter Syntax
$result = $client->updateWebACL([ 'AssociationConfig' => [ 'RequestBody' => [ '<AssociatedResourceType>' => [ 'DefaultSizeInspectionLimit' => 'KB_16|KB_32|KB_48|KB_64', // REQUIRED ], // ... ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'CustomResponseBodies' => [ '<EntityName>' => [ 'Content' => '<string>', // REQUIRED 'ContentType' => 'TEXT_PLAIN|TEXT_HTML|APPLICATION_JSON', // REQUIRED ], // ... ], 'DefaultAction' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Description' => '<string>', 'Id' => '<string>', // REQUIRED 'LockToken' => '<string>', // REQUIRED 'Name' => '<string>', // REQUIRED 'Rules' => [ [ 'Action' => [ 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'CaptchaConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'ChallengeConfig' => [ 'ImmunityTimeProperty' => [ 'ImmunityTime' => <integer>, // REQUIRED ], ], 'Name' => '<string>', // REQUIRED 'OverrideAction' => [ 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'None' => [ ], ], 'Priority' => <integer>, // REQUIRED 'RuleLabels' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'Statement' => [ // REQUIRED 'AndStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'ByteMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'PositionalConstraint' => 'EXACTLY|STARTS_WITH|ENDS_WITH|CONTAINS|CONTAINS_WORD', // REQUIRED 'SearchString' => <string || resource || Psr\Http\Message\StreamInterface>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'GeoMatchStatement' => [ 'CountryCodes' => ['<string>', ...], 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], ], 'IPSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'IPSetForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED 'Position' => 'FIRST|LAST|ANY', // REQUIRED ], ], 'LabelMatchStatement' => [ 'Key' => '<string>', // REQUIRED 'Scope' => 'LABEL|NAMESPACE', // REQUIRED ], 'ManagedRuleGroupStatement' => [ 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'ManagedRuleGroupConfigs' => [ [ 'AWSManagedRulesACFPRuleSet' => [ 'CreationPath' => '<string>', // REQUIRED 'EnableRegexInPath' => true || false, 'RegistrationPagePath' => '<string>', // REQUIRED 'RequestInspection' => [ // REQUIRED 'AddressFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'EmailField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'PhoneNumberFields' => [ [ 'Identifier' => '<string>', // REQUIRED ], // ... ], 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesATPRuleSet' => [ 'EnableRegexInPath' => true || false, 'LoginPath' => '<string>', // REQUIRED 'RequestInspection' => [ 'PasswordField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', // REQUIRED 'UsernameField' => [ // REQUIRED 'Identifier' => '<string>', // REQUIRED ], ], 'ResponseInspection' => [ 'BodyContains' => [ 'FailureStrings' => ['<string>', ...], // REQUIRED 'SuccessStrings' => ['<string>', ...], // REQUIRED ], 'Header' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Name' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'Json' => [ 'FailureValues' => ['<string>', ...], // REQUIRED 'Identifier' => '<string>', // REQUIRED 'SuccessValues' => ['<string>', ...], // REQUIRED ], 'StatusCode' => [ 'FailureCodes' => [<integer>, ...], // REQUIRED 'SuccessCodes' => [<integer>, ...], // REQUIRED ], ], ], 'AWSManagedRulesBotControlRuleSet' => [ 'EnableMachineLearning' => true || false, 'InspectionLevel' => 'COMMON|TARGETED', // REQUIRED ], 'LoginPath' => '<string>', 'PasswordField' => [ 'Identifier' => '<string>', // REQUIRED ], 'PayloadType' => 'JSON|FORM_ENCODED', 'UsernameField' => [ 'Identifier' => '<string>', // REQUIRED ], ], // ... ], 'Name' => '<string>', // REQUIRED 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], 'ScopeDownStatement' => [...], // RECURSIVE 'VendorName' => '<string>', // REQUIRED 'Version' => '<string>', ], 'NotStatement' => [ 'Statement' => [...], // REQUIRED, RECURSIVE ], 'OrStatement' => [ 'Statements' => [ // REQUIRED [...], // RECURSIVE // ... ], ], 'RateBasedStatement' => [ 'AggregateKeyType' => 'IP|FORWARDED_IP|CUSTOM_KEYS|CONSTANT', // REQUIRED 'CustomKeys' => [ [ 'Cookie' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'ForwardedIP' => [ ], 'HTTPMethod' => [ ], 'Header' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'IP' => [ ], 'LabelNamespace' => [ 'Namespace' => '<string>', // REQUIRED ], 'QueryArgument' => [ 'Name' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'QueryString' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'UriPath' => [ 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], // ... ], 'EvaluationWindowSec' => <integer>, 'ForwardedIPConfig' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED 'HeaderName' => '<string>', // REQUIRED ], 'Limit' => <integer>, // REQUIRED 'ScopeDownStatement' => [...], // RECURSIVE ], 'RegexMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'RegexString' => '<string>', // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RegexPatternSetReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'RuleGroupReferenceStatement' => [ 'ARN' => '<string>', // REQUIRED 'ExcludedRules' => [ [ 'Name' => '<string>', // REQUIRED ], // ... ], 'RuleActionOverrides' => [ [ 'ActionToUse' => [ // REQUIRED 'Allow' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Block' => [ 'CustomResponse' => [ 'CustomResponseBodyKey' => '<string>', 'ResponseCode' => <integer>, // REQUIRED 'ResponseHeaders' => [ [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Captcha' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Challenge' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], 'Count' => [ 'CustomRequestHandling' => [ 'InsertHeaders' => [ // REQUIRED [ 'Name' => '<string>', // REQUIRED 'Value' => '<string>', // REQUIRED ], // ... ], ], ], ], 'Name' => '<string>', // REQUIRED ], // ... ], ], 'SizeConstraintStatement' => [ 'ComparisonOperator' => 'EQ|NE|LE|LT|GE|GT', // REQUIRED 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'Size' => <integer>, // REQUIRED 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'SqliMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'SensitivityLevel' => 'LOW|HIGH', 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], 'XssMatchStatement' => [ 'FieldToMatch' => [ // REQUIRED 'AllQueryArguments' => [ ], 'Body' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Cookies' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedCookies' => ['<string>', ...], 'IncludedCookies' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'HeaderOrder' => [ 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'Headers' => [ 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'ExcludedHeaders' => ['<string>', ...], 'IncludedHeaders' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', // REQUIRED ], 'JA3Fingerprint' => [ 'FallbackBehavior' => 'MATCH|NO_MATCH', // REQUIRED ], 'JsonBody' => [ 'InvalidFallbackBehavior' => 'MATCH|NO_MATCH|EVALUATE_AS_STRING', 'MatchPattern' => [ // REQUIRED 'All' => [ ], 'IncludedPaths' => ['<string>', ...], ], 'MatchScope' => 'ALL|KEY|VALUE', // REQUIRED 'OversizeHandling' => 'CONTINUE|MATCH|NO_MATCH', ], 'Method' => [ ], 'QueryString' => [ ], 'SingleHeader' => [ 'Name' => '<string>', // REQUIRED ], 'SingleQueryArgument' => [ 'Name' => '<string>', // REQUIRED ], 'UriPath' => [ ], ], 'TextTransformations' => [ // REQUIRED [ 'Priority' => <integer>, // REQUIRED 'Type' => 'NONE|COMPRESS_WHITE_SPACE|HTML_ENTITY_DECODE|LOWERCASE|CMD_LINE|URL_DECODE|BASE64_DECODE|HEX_DECODE|MD5|REPLACE_COMMENTS|ESCAPE_SEQ_DECODE|SQL_HEX_DECODE|CSS_DECODE|JS_DECODE|NORMALIZE_PATH|NORMALIZE_PATH_WIN|REMOVE_NULLS|REPLACE_NULLS|BASE64_DECODE_EXT|URL_DECODE_UNI|UTF8_TO_UNICODE', // REQUIRED ], // ... ], ], ], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ], // ... ], 'Scope' => 'CLOUDFRONT|REGIONAL', // REQUIRED 'TokenDomains' => ['<string>', ...], 'VisibilityConfig' => [ // REQUIRED 'CloudWatchMetricsEnabled' => true || false, // REQUIRED 'MetricName' => '<string>', // REQUIRED 'SampledRequestsEnabled' => true || false, // REQUIRED ], ]);
Parameter Details
Members
- AssociationConfig
-
- Type: AssociationConfig structure
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 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).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
- CaptchaConfig
-
- Type: CaptchaConfig structure
Specifies how WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
. - ChallengeConfig
-
- Type: ChallengeConfig structure
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, WAF uses its default settings forChallengeConfig
. - CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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 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.
- DefaultAction
-
- Required: Yes
- Type: DefaultAction structure
The action to perform if none of the
Rules
contained in theWebACL
match. - Description
-
- Type: string
A description of the web ACL that helps with identification.
- Id
-
- Required: Yes
- Type: string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Required: Yes
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- Rules
-
- Type: Array of Rule structures
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.
- Scope
-
- Required: Yes
- Type: string
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.
- TokenDomains
-
- Type: Array of strings
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, 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. - VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Result Syntax
[ 'NextLockToken' => '<string>', ]
Result Details
Members
- NextLockToken
-
- Type: string
A token used for optimistic locking. WAF returns this token to your
update
requests. You useNextLockToken
in the same manner as you useLockToken
.
Errors
- WAFInternalErrorException:
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
- WAFInvalidParameterException:
The operation failed because 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.
-
- WAFNonexistentItemException:
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.
- WAFDuplicateItemException:
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
- WAFOptimisticLockException:
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.
- WAFLimitsExceededException:
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.- WAFInvalidResourceException:
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
- WAFUnavailableEntityException:
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.
- WAFSubscriptionNotFoundException:
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
- WAFInvalidOperationException:
The operation isn't valid.
- 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.
- 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
).
Shapes
APIKeySummary
Description
Information for a single API key.
API keys are required for the integration of the CAPTCHA API in your JavaScript client applications. The API lets you customize the placement and characteristics of the CAPTCHA puzzle for your end users. For more information about the CAPTCHA JavaScript integration, see WAF client application integration in the WAF Developer Guide.
Members
- APIKey
-
- Type: string
The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.
- CreationTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the key was created.
- TokenDomains
-
- Type: Array of strings
The token domains that are defined in this API key.
- Version
-
- Type: int
Internal value used by WAF to manage the key.
AWSManagedRulesACFPRuleSet
Description
Details for your use of the account creation fraud prevention managed rule group, AWSManagedRulesACFPRuleSet
. This configuration is used in ManagedRuleGroupConfig
.
Members
- CreationPath
-
- Required: Yes
- Type: string
The path of the account creation endpoint for your application. This is the page on your website that accepts the completed registration form for a new user. This page must accept
POST
requests.For example, for the URL
https://example.com/web/newaccount
, you would provide the path/web/newaccount
. Account creation page paths that start with the path that you provide are considered a match. For example/web/newaccount
matches the account creation paths/web/newaccount
,/web/newaccount/
,/web/newaccountPage
, and/web/newaccount/thisPage
, but doesn't match the path/home/web/newaccount
or/website/newaccount
. - EnableRegexInPath
-
- Type: boolean
Allow the use of regular expressions in the registration page path and the account creation path.
- RegistrationPagePath
-
- Required: Yes
- Type: string
The path of the account registration endpoint for your application. This is the page on your website that presents the registration form to new users.
This page must accept
GET
text/html requests.For example, for the URL
https://example.com/web/registration
, you would provide the path/web/registration
. Registration page paths that start with the path that you provide are considered a match. For example/web/registration
matches the registration paths/web/registration
,/web/registration/
,/web/registrationPage
, and/web/registration/thisPage
, but doesn't match the path/home/web/registration
or/website/registration
. - RequestInspection
-
- Required: Yes
- Type: RequestInspectionACFP structure
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
- ResponseInspection
-
- Type: ResponseInspection structure
The criteria for inspecting responses to account creation requests, used by the ACFP rule group to track account creation success rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ACFP rule group evaluates the responses that your protected resources send back to client account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many successful account creation attempts in a short amount of time.
AWSManagedRulesATPRuleSet
Description
Details for your use of the account takeover prevention managed rule group, AWSManagedRulesATPRuleSet
. This configuration is used in ManagedRuleGroupConfig
.
Members
- EnableRegexInPath
-
- Type: boolean
Allow the use of regular expressions in the login page path.
- LoginPath
-
- Required: Yes
- Type: string
The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login
, you would provide the path/web/login
. Login paths that start with the path that you provide are considered a match. For example/web/login
matches the login paths/web/login
,/web/login/
,/web/loginPage
, and/web/login/thisPage
, but doesn't match the login path/home/web/login
or/website/login
.The rule group inspects only HTTP
POST
requests to your specified login endpoint. - RequestInspection
-
- Type: RequestInspection structure
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
- ResponseInspection
-
- Type: ResponseInspection structure
The criteria for inspecting responses to login requests, used by the ATP rule group to track login failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The ATP rule group evaluates the responses that your protected resources send back to client login attempts, keeping count of successful and failed attempts for each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses that have had too many failed login attempts in a short amount of time.
AWSManagedRulesBotControlRuleSet
Description
Details for your use of the Bot Control managed rule group, AWSManagedRulesBotControlRuleSet
. This configuration is used in ManagedRuleGroupConfig
.
Members
- EnableMachineLearning
-
- Type: boolean
Applies only to the targeted inspection level.
Determines whether to use machine learning (ML) to analyze your web traffic for bot-related activity. Machine learning is required for the Bot Control rules
TGT_ML_CoordinatedActivityLow
andTGT_ML_CoordinatedActivityMedium
, which inspect for anomalous behavior that might indicate distributed, coordinated bot activity.For more information about this choice, see the listing for these rules in the table at Bot Control rules listing in the WAF Developer Guide.
Default:
TRUE
- InspectionLevel
-
- Required: Yes
- Type: string
The inspection level to use for the Bot Control rule group. The common level is the least expensive. The targeted level includes all common level rules and adds rules with more advanced inspection criteria. For details, see WAF Bot Control rule group in the WAF Developer Guide.
ActionCondition
Description
A single action condition for a Condition in a logging filter.
Members
- Action
-
- Required: Yes
- Type: string
The action setting that a log record must contain in order to meet the condition. This is the action that WAF applied to the web request.
For rule groups, this is either the configured rule action setting, or if you've applied a rule action override to the rule, it's the override action. The value
EXCLUDED_AS_COUNT
matches on excluded rules and also on rules that have a rule action override of Count.
AddressField
Description
The name of a field in the request payload that contains part or all of your customer's primary physical address.
This data type is used in the RequestInspectionACFP
data type.
Members
- Identifier
-
- Required: Yes
- Type: string
The name of a single primary address field.
How you specify the address fields depends on the request inspection payload type.
-
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.
All
Description
Inspect all of the elements that WAF has parsed and extracted from the web request component that you've identified in your FieldToMatch specifications.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: "All": {}
Members
AllQueryArguments
Description
Inspect all query arguments of the web request.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: "AllQueryArguments": {}
Members
AllowAction
Description
Specifies that WAF should allow the request and optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
Members
- CustomRequestHandling
-
- Type: CustomRequestHandling structure
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
AndStatement
Description
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement
.
Members
- Statements
-
- Required: Yes
- Type: Array of Statement structures
The statements to combine with AND logic. You can use any statements that can be nested.
AssociationConfig
Description
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 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).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
Members
- RequestBody
-
- Type: Associative array of custom strings keys (AssociatedResourceType) to RequestBodyAssociatedResourceTypeConfig structures
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
Example JSON:
{ "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
BlockAction
Description
Specifies that WAF should block the request and optionally defines additional custom handling for the response to the web request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
Members
- CustomResponse
-
- Type: CustomResponse structure
Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
Body
Description
Inspect the body of the web request. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Members
- OversizeHandling
-
- Type: string
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
-
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
-
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
-
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
ByteMatchStatement
Description
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.
Members
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- PositionalConstraint
-
- Required: Yes
- Type: string
The area within the portion of the web request that you want WAF to search for
SearchString
. Valid values include the following:CONTAINS
The specified part of the web request must include the value of
SearchString
, but the location doesn't matter.CONTAINS_WORD
The specified part of the web request must include the value of
SearchString
, andSearchString
must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In addition,SearchString
must be a word, which means that both of the following are true:-
SearchString
is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (_). Examples include the value of a header and;BadBot
. -
SearchString
is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example,BadBot;
and-BadBot;
.
EXACTLY
The value of the specified part of the web request must exactly match the value of
SearchString
.STARTS_WITH
The value of
SearchString
must appear at the beginning of the specified part of the web request.ENDS_WITH
The value of
SearchString
must appear at the end of the specified part of the web request. - SearchString
-
- Required: Yes
- Type: blob (string|resource|Psr\Http\Message\StreamInterface)
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 200 bytes.
Valid values depend on the component that you specify for inspection in
FieldToMatch
:-
Method
: The HTTP method that you want WAF to search for. This indicates the type of operation specified in the request. -
UriPath
: The value that you want WAF to search for in the URI path, for example,/images/daily-ad.jpg
. -
JA3Fingerprint
: Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. You can use this choice only with a string matchByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
-
HeaderOrder
: The list of header names to match for. WAF creates a string that contains the ordered list of header names, from the headers in the web request, and then matches against that string.
If
SearchString
includes alphabetic characters A-Z and a-z, note that the value is case sensitive.If you're using the WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 200 bytes.
For example, suppose the value of
Type
isHEADER
and the value ofData
isUser-Agent
. If you want to search theUser-Agent
header for the valueBadBot
, you base64-encodeBadBot
using MIME base64-encoding and include the resulting value,QmFkQm90
, in the value ofSearchString
.If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
CaptchaAction
Description
Specifies that WAF should run a CAPTCHA
check against the request:
-
If the request includes a valid, unexpired
CAPTCHA
token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to aCountAction
. -
If the request doesn't include a valid, unexpired token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
WAF generates a response that it sends back to the client, which includes the following:
-
The header
x-amzn-waf-action
with a value ofcaptcha
. -
The HTTP status code
405 Method Not Allowed
. -
If the request contains an
Accept
header with a value oftext/html
, the response includes aCAPTCHA
JavaScript page interstitial.
-
You can configure the expiration time in the CaptchaConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
Members
- CustomRequestHandling
-
- Type: CustomRequestHandling structure
Defines custom handling for the web request, used when the
CAPTCHA
inspection determines that the request's token is valid and unexpired.For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
CaptchaConfig
Description
Specifies how WAF should handle CAPTCHA
evaluations. This is available at the web ACL level and in each rule.
Members
- ImmunityTimeProperty
-
- Type: ImmunityTimeProperty structure
Determines how long a
CAPTCHA
timestamp in the token remains valid after the client successfully solves aCAPTCHA
puzzle.
CaptchaResponse
Description
The result from the inspection of the web request for a valid CAPTCHA
token.
Members
- FailureReason
-
- Type: string
The reason for failure, populated when the evaluation of the token fails.
- ResponseCode
-
- Type: int
The HTTP response code indicating the status of the
CAPTCHA
token in the web request. If the token is missing, invalid, or expired, this code is405 Method Not Allowed
. - SolveTimestamp
-
- Type: long (int|float)
The time that the
CAPTCHA
was last solved for the supplied token.
ChallengeAction
Description
Specifies that WAF should run a Challenge
check against the request to verify that the request is coming from a legitimate client session:
-
If the request includes a valid, unexpired challenge token, WAF applies any custom request handling and labels that you've configured and then allows the web request inspection to proceed to the next rule, similar to a
CountAction
. -
If the request doesn't include a valid, unexpired challenge token, WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.
WAF then generates a challenge response that it sends back to the client, which includes the following:
-
The header
x-amzn-waf-action
with a value ofchallenge
. -
The HTTP status code
202 Request Accepted
. -
If the request contains an
Accept
header with a value oftext/html
, the response includes a JavaScript page interstitial with a challenge script.
Challenges run silent browser interrogations in the background, and don't generally affect the end user experience.
A challenge enforces token acquisition using an interstitial JavaScript challenge that inspects the client session for legitimate behavior. The challenge blocks bots or at least increases the cost of operating sophisticated bots.
After the client session successfully responds to the challenge, it receives a new token from WAF, which the challenge script uses to resubmit the original request.
-
You can configure the expiration time in the ChallengeConfig
ImmunityTimeProperty
setting at the rule and web ACL level. The rule setting overrides the web ACL setting.
This action option is available for rules. It isn't available for web ACL default actions.
Members
- CustomRequestHandling
-
- Type: CustomRequestHandling structure
Defines custom handling for the web request, used when the challenge inspection determines that the request's token is valid and unexpired.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
ChallengeConfig
Description
Specifies how WAF should handle Challenge
evaluations. This is available at the web ACL level and in each rule.
Members
- ImmunityTimeProperty
-
- Type: ImmunityTimeProperty structure
Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.
ChallengeResponse
Description
The result from the inspection of the web request for a valid challenge token.
Members
- FailureReason
-
- Type: string
The reason for failure, populated when the evaluation of the token fails.
- ResponseCode
-
- Type: int
The HTTP response code indicating the status of the challenge token in the web request. If the token is missing, invalid, or expired, this code is
202 Request Accepted
. - SolveTimestamp
-
- Type: long (int|float)
The time that the challenge was last solved for the supplied token.
Condition
Description
A single match condition for a Filter.
Members
- ActionCondition
-
- Type: ActionCondition structure
A single action condition. This is the action setting that a log record must contain in order to meet the condition.
- LabelNameCondition
-
- Type: LabelNameCondition structure
A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
CookieMatchPattern
Description
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All
, IncludedCookies
, or ExcludedCookies
.
Example JSON: "MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
Members
- All
-
- Type: All structure
Inspect all cookies.
- ExcludedCookies
-
- Type: Array of strings
Inspect only the cookies whose keys don't match any of the strings specified here.
- IncludedCookies
-
- Type: Array of strings
Inspect only the cookies that have a key that matches one of the strings specified here.
Cookies
Description
Inspect the cookies in the web request. You can specify the parts of the cookies to inspect and you can narrow the set of cookies to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: "Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
Members
- MatchPattern
-
- Required: Yes
- Type: CookieMatchPattern structure
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedCookies
, orExcludedCookies
.Example JSON:
"MatchPattern": { "IncludedCookies": [ "session-id-time", "session-id" ] }
- MatchScope
-
- Required: Yes
- Type: string
The parts of the cookies to inspect with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values. - OversizeHandling
-
- Required: Yes
- Type: string
What WAF should do if the cookies of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
-
CONTINUE
- Inspect the available cookies normally, according to the rule inspection criteria. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
CountAction
Description
Specifies that WAF should count the request. Optionally defines additional custom handling for the request.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
Members
- CustomRequestHandling
-
- Type: CustomRequestHandling structure
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
CustomHTTPHeader
Description
A custom header for custom request and response handling. This is used in CustomResponse and CustomRequestHandling.
Members
- Name
-
- Required: Yes
- Type: string
The name of the custom header.
For custom request header insertion, when WAF inserts the header into the request, it prefixes this name
x-amzn-waf-
, to avoid confusion with the headers that are already in the request. For example, for the header namesample
, WAF inserts the headerx-amzn-waf-sample
. - Value
-
- Required: Yes
- Type: string
The value of the custom header.
CustomRequestHandling
Description
Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for WAF to use when the rule action doesn't block the request. For example, CaptchaAction
for requests with valid t okens, and AllowAction
.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
Members
- InsertHeaders
-
- Required: Yes
- Type: Array of CustomHTTPHeader structures
The HTTP headers to insert into the request. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
CustomResponse
Description
A custom response to send to the client. You can define a custom response for rule actions and default web ACL actions that are set to BlockAction.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
Members
- CustomResponseBodyKey
-
- Type: string
References the response body that you want WAF to return to the web request client. You can define a custom response for a rule action or a default web ACL action that is set to block. To do this, you first define the response body key and value in the
CustomResponseBodies
setting for the WebACL or RuleGroup where you want to use it. Then, in the rule action or web ACL default actionBlockAction
setting, you reference the response body using this key. - ResponseCode
-
- Required: Yes
- Type: int
The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
- ResponseHeaders
-
- Type: Array of CustomHTTPHeader structures
The HTTP headers to use in the response. You can specify any header name except for
content-type
. Duplicate header names are not allowed.For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
CustomResponseBody
Description
The response body to use in a custom response to a web request. This is referenced by key from CustomResponse CustomResponseBodyKey
.
Members
- Content
-
- Required: Yes
- Type: string
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType
setting.For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
- ContentType
-
- Required: Yes
- Type: string
The type of content in the payload that you are defining in the
Content
string.
DefaultAction
Description
In a WebACL, this is the action that you want WAF to perform when a web request doesn't match any of the rules in the WebACL
. The default action must be a terminating action.
Members
- Allow
-
- Type: AllowAction structure
Specifies that WAF should allow requests by default.
- Block
-
- Type: BlockAction structure
Specifies that WAF should block requests by default.
EmailField
Description
The name of the field in the request payload that contains your customer's email.
This data type is used in the RequestInspectionACFP
data type.
Members
- Identifier
-
- Required: Yes
- Type: string
The name of the email field.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.
ExcludedRule
Description
Specifies a single rule in a rule group whose action you want to override to Count
.
Instead of this option, use RuleActionOverrides
. It accepts any valid action setting, including Count
.
Members
- Name
-
- Required: Yes
- Type: string
The name of the rule whose action you want to override to
Count
.
FieldToMatch
Description
Specifies a web request component to be used in a rule match statement or in a logging configuration.
-
In a rule statement, this is the part of the web request that you want WAF to inspect. Include the single
FieldToMatch
type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component inFieldToMatch
for each rule statement that requires it. To inspect more than one component of the web request, create a separate rule statement for each component.Example JSON for a
QueryString
field to match:"FieldToMatch": { "QueryString": {} }
Example JSON for a
Method
field to match specification:"FieldToMatch": { "Method": { "Name": "DELETE" } }
-
In a logging configuration, this is used in the
RedactedFields
property to specify a field to redact from the logging records. For this use case, note the following:-
Even though all
FieldToMatch
settings are available, the only valid settings for field redaction areUriPath
,QueryString
,SingleHeader
, andMethod
. -
In this documentation, the descriptions of the individual fields talk about specifying the web request component to inspect, but for field redaction, you are specifying the component type to redact from the logs.
-
If you have request sampling enabled, the redacted fields configuration for logging has no impact on sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
-
Members
- AllQueryArguments
-
- Type: AllQueryArguments structure
Inspect all query arguments.
- Body
-
- Type: Body structure
Inspect the request body as plain text. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
-
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
-
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
Body
object configuration. - Cookies
-
- Type: Cookies structure
Inspect the request cookies. You must configure scope and pattern matching filters in the
Cookies
object, to define the set of cookies and the parts of the cookies that WAF inspects.Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies
object. WAF applies the pattern matching filters to the cookies that it receives from the underlying host service. - HeaderOrder
-
- Type: HeaderOrder structure
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example
host:user-agent:accept:authorization:referer
. - Headers
-
- Type: Headers structure
Inspect the request headers. You must configure scope and pattern matching filters in the
Headers
object, to define the set of headers to and the parts of the headers that WAF inspects.Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers
object. WAF applies the pattern matching filters to the headers that it receives from the underlying host service. - JA3Fingerprint
-
- Type: JA3Fingerprint structure
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match
ByteMatchStatement
with thePositionalConstraint
set toEXACTLY
.You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
- JsonBody
-
- Type: JsonBody structure
Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
-
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
-
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
For information about how to handle oversized request bodies, see the
JsonBody
object configuration. - Method
-
- Type: Method structure
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
- QueryString
-
- Type: QueryString structure
Inspect the query string. This is the part of a URL that appears after a
?
character, if any. - SingleHeader
-
- Type: SingleHeader structure
Inspect a single header. Provide the name of the header to inspect, for example,
User-Agent
orReferer
. This setting isn't case sensitive.Example JSON:
"SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the
Headers
FieldToMatch
setting. - SingleQueryArgument
-
- Type: SingleQueryArgument structure
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
Example JSON:
"SingleQueryArgument": { "Name": "myArgument" }
- UriPath
-
- Type: UriPath structure
Inspect the request URI path. This is the part of the web request that identifies a resource, for example,
/images/daily-ad.jpg
.
Filter
Description
A single logging filter, used in LoggingFilter.
Members
- Behavior
-
- Required: Yes
- Type: string
How to handle logs that satisfy the filter's conditions and requirement.
- Conditions
-
- Required: Yes
- Type: Array of Condition structures
Match conditions for the filter.
- Requirement
-
- Required: Yes
- Type: string
Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.
FirewallManagerRuleGroup
Description
A rule group that's defined for an Firewall Manager WAF policy.
Members
- FirewallManagerStatement
-
- Required: Yes
- Type: FirewallManagerStatement structure
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
- Name
-
- Required: Yes
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- OverrideAction
-
- Required: Yes
- Type: OverrideAction structure
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
Count
action, in your rule group reference statement settings. - Priority
-
- Required: Yes
- Type: int
If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
FirewallManagerStatement
Description
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a single rule group reference.
Members
- ManagedRuleGroupStatement
-
- Type: ManagedRuleGroupStatement structure
A statement used by Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.
- RuleGroupReferenceStatement
-
- Type: RuleGroupReferenceStatement structure
A statement used by Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an Firewall Manager WAF policy.
ForwardedIPConfig
Description
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This configuration is used for GeoMatchStatement and RateBasedStatement. For IPSetReferenceStatement, use IPSetForwardedIPConfig instead.
WAF only evaluates the first IP address found in the specified HTTP header.
Members
- FallbackBehavior
-
- Required: Yes
- Type: string
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
-
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
- HeaderName
-
- Required: Yes
- Type: string
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
GeoMatchStatement
Description
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
-
To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. -
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match ForwardedIPConfig
.
If you use the web request origin, the label formats are awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
and awswaf:clientip:geo:country:<ISO country code>
.
If you use a forwarded IP address, the label formats are awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
and awswaf:forwardedip:geo:country:<ISO country code>
.
For additional details, see Geographic match rule statement in the WAF Developer Guide.
Members
- CountryCodes
-
- Type: Array of strings
An array of two-character country codes that you want to match against, for example,
[ "US", "CN" ]
, from the alpha-2 country ISO codes of the ISO 3166 international standard.When you use a geo match statement just for the region and country labels that it adds to requests, you still have to supply a country code for the rule to evaluate. In this case, you configure the rule to only count matching requests, but it will still generate logging and count metrics for any matches. You can reduce the logging and metrics that the rule produces by specifying a country that's unlikely to be a source of traffic to your site.
- ForwardedIPConfig
-
- Type: ForwardedIPConfig structure
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
HTTPHeader
Description
Part of the response from GetSampledRequests. This is a complex type that appears as Headers
in the response syntax. HTTPHeader
contains the names and values of all of the headers that appear in one of the web requests.
Members
- Name
-
- Type: string
The name of the HTTP header.
- Value
-
- Type: string
The value of the HTTP header.
HTTPRequest
Description
Part of the response from GetSampledRequests. This is a complex type that appears as Request
in the response syntax. HTTPRequest
contains information about one of the web requests.
Members
- ClientIP
-
- Type: string
The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:
-
c-ip
, if the viewer did not use an HTTP proxy or a load balancer to send the request -
x-forwarded-for
, if the viewer did use an HTTP proxy or a load balancer to send the request
- Country
-
- Type: string
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
- HTTPVersion
-
- Type: string
The HTTP version specified in the sampled web request, for example,
HTTP/1.1
. - Headers
-
- Type: Array of HTTPHeader structures
A complex type that contains the name and value for each header in the sampled web request.
- Method
-
- Type: string
The HTTP method specified in the sampled web request.
- URI
-
- Type: string
The URI path of the request, which identifies the resource, for example,
/images/daily-ad.jpg
.
HeaderMatchPattern
Description
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All
, IncludedHeaders
, or ExcludedHeaders
.
Example JSON: "MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
Members
- All
-
- Type: All structure
Inspect all headers.
- ExcludedHeaders
-
- Type: Array of strings
Inspect only the headers whose keys don't match any of the strings specified here.
- IncludedHeaders
-
- Type: Array of strings
Inspect only the headers that have a key that matches one of the strings specified here.
HeaderOrder
Description
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that WAF receives for inspection. WAF generates the string and then uses that as the field to match component in its inspection. WAF separates the header names in the string using colons and no added spaces, for example host:user-agent:accept:authorization:referer
.
Members
- OversizeHandling
-
- Required: Yes
- Type: string
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
-
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
Headers
Description
Inspect all headers in the web request. You can specify the parts of the headers to inspect and you can narrow the set of headers to inspect by including or excluding specific keys.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
If you want to inspect just the value of a single header, use the SingleHeader
FieldToMatch
setting instead.
Example JSON: "Headers": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }
Members
- MatchPattern
-
- Required: Yes
- Type: HeaderMatchPattern structure
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either
All
,IncludedHeaders
, orExcludedHeaders
.Example JSON:
"MatchPattern": { "ExcludedHeaders": [ "KeyToExclude1", "KeyToExclude2" ] }
- MatchScope
-
- Required: Yes
- Type: string
The parts of the headers to match with the rule inspection criteria. If you specify
ALL
, WAF inspects both keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values. - OversizeHandling
-
- Required: Yes
- Type: string
What WAF should do if the headers of the request are more numerous or larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
-
CONTINUE
- Inspect the available headers normally, according to the rule inspection criteria. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
IPSet
Description
Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
WAF assigns an ARN to each IPSet
that you create. To use an IP set in a rule, you provide the ARN to the Rule statement IPSetReferenceStatement.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Addresses
-
- Required: Yes
- Type: Array of strings
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for
/0
.Example address strings:
-
For requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32
. -
For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
. -
For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. -
For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON
Addresses
specifications:-
Empty array:
"Addresses": []
-
Array with one address:
"Addresses": ["192.0.2.44/32"]
-
Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
-
INVALID specification:
"Addresses": [""]
INVALID
- Description
-
- Type: string
A description of the IP set that helps with identification.
- IPAddressVersion
-
- Required: Yes
- Type: string
The version of the IP addresses, either
IPV4
orIPV6
. - Id
-
- Required: Yes
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Required: Yes
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it.
IPSetForwardedIPConfig
Description
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This configuration is used only for IPSetReferenceStatement. For GeoMatchStatement and RateBasedStatement, use ForwardedIPConfig instead.
Members
- FallbackBehavior
-
- Required: Yes
- Type: string
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
-
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
- HeaderName
-
- Required: Yes
- Type: string
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to
X-Forwarded-For
.If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
- Position
-
- Required: Yes
- Type: string
The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be
10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went through.The options for this setting are the following:
-
FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
-
LAST - Inspect the last IP address in the list of IP addresses in the header.
-
ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
IPSetReferenceStatement
Description
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the IPSet that this statement references.
- IPSetForwardedIPConfig
-
- Type: IPSetForwardedIPConfig structure
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
IPSetSummary
Description
High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet
, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the IP set that helps with identification.
- Id
-
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Type: string
The name of the IP set. You cannot change the name of an
IPSet
after you create it.
ImmunityTimeProperty
Description
Used for CAPTCHA and challenge token settings. Determines how long a CAPTCHA
or challenge timestamp remains valid after WAF updates it for a successful CAPTCHA
or challenge response.
Members
- ImmunityTime
-
- Required: Yes
- Type: long (int|float)
The amount of time, in seconds, that a
CAPTCHA
or challenge timestamp is considered valid by WAF. The default setting is 300.For the Challenge action, the minimum setting is 300.
JA3Fingerprint
Description
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA3 fingerprint. The JA3 fingerprint is a 32-character hash derived from the TLS Client Hello of an incoming request. This fingerprint serves as a unique identifier for the client's TLS configuration. WAF calculates and logs this fingerprint for each request that has enough TLS Client Hello information for the calculation. Almost all web requests include this information.
You can use this choice only with a string match ByteMatchStatement
with the PositionalConstraint
set to EXACTLY
.
You can obtain the JA3 fingerprint for client requests from the web ACL logs. If WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see Log fields in the WAF Developer Guide.
Provide the JA3 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.
Members
- FallbackBehavior
-
- Required: Yes
- Type: string
The match status to assign to the web request if the request doesn't have a JA3 fingerprint.
You can specify the following fallback behaviors:
-
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
JsonBody
Description
Inspect the body of the web request as JSON. The body immediately follows the request headers.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. WAF inspects only the parts of the JSON that result from the matches that you indicate.
Example JSON: "JsonBody": { "MatchPattern": { "All": {} }, "MatchScope": "ALL" }
For additional information about this request component option, see JSON body in the WAF Developer Guide.
Members
- InvalidFallbackBehavior
-
- Type: string
What WAF should do if it fails to completely parse the JSON body. The options are the following:
-
EVALUATE_AS_STRING
- Inspect the body as plain text. WAF applies the text transformations and inspection criteria that you defined for the JSON inspection to the body text string. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, WAF doesn't apply the fallback behavior. For more information, see JSON body in the WAF Developer Guide.
- MatchPattern
-
- Required: Yes
- Type: JsonMatchPattern structure
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
- MatchScope
-
- Required: Yes
- Type: string
The parts of the JSON to match against using the
MatchPattern
. If you specifyALL
, WAF matches against keys and values.All
does not require a match to be found in the keys and a match to be found in the values. It requires a match to be found in the keys or the values or both. To require a match in the keys and in the values, use a logicalAND
statement to combine two match rules, one that inspects the keys and another that inspects the values. - OversizeHandling
-
- Type: string
What WAF should do if the body is larger than WAF can inspect.
WAF does not support inspecting the entire contents of the web request body if the body exceeds the limit for the resource type. When a web request body is larger than the limit, the underlying host service only forwards the contents that are within the limit to WAF for inspection.
-
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
-
For CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access, the default limit is 16 KB (16,384 bytes), and you can increase the limit for each resource type in the web ACL
AssociationConfig
, for additional processing fees.
The options for oversize handling are the following:
-
CONTINUE
- Inspect the available body contents normally, according to the rule inspection criteria. -
MATCH
- Treat the web request as matching the rule statement. WAF applies the rule action to the request. -
NO_MATCH
- Treat the web request as not matching the rule statement.
You can combine the
MATCH
orNO_MATCH
settings for oversize handling with your rule and web ACL action settings, so that you block any request whose body is over the limit.Default:
CONTINUE
JsonMatchPattern
Description
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the FieldToMatch option JsonBody
.
Members
- All
-
- Type: All structure
Match all of the elements. See also
MatchScope
in JsonBody.You must specify either this setting or the
IncludedPaths
setting, but not both. - IncludedPaths
-
- Type: Array of strings
Match only the specified include paths. See also
MatchScope
in JsonBody.Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]
. For information about this syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.You must specify either this setting or the
All
setting, but not both.Don't use this option to include all paths. Instead, use the
All
setting.
Label
Description
A single label container. This is used as an element of a label array in multiple contexts, for example, in RuleLabels
inside a Rule and in Labels
inside a SampledHTTPRequest.
Members
- Name
-
- Required: Yes
- Type: string
The label string.
LabelMatchStatement
Description
A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
Members
- Key
-
- Required: Yes
- Type: string
The string to match against. The setting you provide for this depends on the match statement's
Scope
setting:-
If the
Scope
indicatesLABEL
, then this specification must include the name and can include any number of preceding namespace specifications and prefix up to providing the fully qualified label name. -
If the
Scope
indicatesNAMESPACE
, then this specification can include any number of contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name
. - Scope
-
- Required: Yes
- Type: string
Specify whether you want to match using the label name or just the namespace.
LabelNameCondition
Description
A single label name condition for a Condition in a logging filter.
Members
- LabelName
-
- Required: Yes
- Type: string
The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
LabelSummary
Description
List of labels used by one or more of the rules of a RuleGroup. This summary object is used for the following rule group lists:
Members
- Name
-
- Type: string
An individual label specification.
LoggingConfiguration
Description
Defines an association between logging destinations and a web ACL resource, for logging from WAF. As part of the association, you can specify parts of the standard logging fields to keep out of the logs and you can specify filters so that you log only a subset of the logging records.
You can define one logging destination per web ACL.
You can access information about the traffic that WAF inspects using the following steps:
-
Create your logging destination. You can use an Amazon CloudWatch Logs log group, an Amazon Simple Storage Service (Amazon S3) bucket, or an Amazon Kinesis Data Firehose.
The name that you give the destination must start with
aws-waf-logs-
. Depending on the type of destination, you might need to configure additional settings or permissions.For configuration requirements and pricing information for each destination type, see Logging web ACL traffic in the WAF Developer Guide.
-
Associate your logging destination to your web ACL using a
PutLoggingConfiguration
request.
When you successfully enable logging using a PutLoggingConfiguration
request, WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, WAF creates a resource policy on the log group. For an Amazon S3 bucket, WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, WAF creates a service-linked role.
For additional information about web ACL logging, see Logging web ACL traffic information in the WAF Developer Guide.
Members
- LogDestinationConfigs
-
- Required: Yes
- Type: Array of strings
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
- LogScope
-
- Type: string
The owner of the logging configuration, which must be set to
CUSTOMER
for the configurations that you manage.The log scope
SECURITY_LAKE
indicates a configuration that is managed through Amazon Security Lake. You can use Security Lake to collect log and event data from various sources for normalization, analysis, and management. For information, see Collecting data from Amazon Web Services services in the Amazon Security Lake user guide.Default:
CUSTOMER
- LogType
-
- Type: string
Used to distinguish between various logging options. Currently, there is one option.
Default:
WAF_LOGS
- LoggingFilter
-
- Type: LoggingFilter structure
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
- ManagedByFirewallManager
-
- Type: boolean
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
The logging configuration can be created by Firewall Manager for use with any web ACL that Firewall Manager is using for an WAF policy. Web ACLs that Firewall Manager creates and uses have their
ManagedByFirewallManager
property set to true. Web ACLs that were created by a customer account and then retrofitted by Firewall Manager for use by a policy have theirRetrofittedByFirewallManager
property set to true. For either case, any corresponding logging configuration will indicateManagedByFirewallManager
. - RedactedFields
-
- Type: Array of FieldToMatch structures
The parts of the request that you want to keep out of the logs.
For example, if you redact the
SingleHeader
field, theHEADER
field in the logs will beREDACTED
for all rules that use theSingleHeader
FieldToMatch
setting.Redaction applies only to the component that's specified in the rule's
FieldToMatch
setting, so theSingleHeader
redaction doesn't apply to rules that use theHeaders
FieldToMatch
.You can specify only the following fields for redaction:
UriPath
,QueryString
,SingleHeader
, andMethod
.This setting has no impact on request sampling. With request sampling, the only way to exclude fields is by disabling sampling in the web ACL visibility configuration.
- ResourceArn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL that you want to associate with
LogDestinationConfigs
.
LoggingFilter
Description
Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's LoggingConfiguration.
You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
Members
- DefaultBehavior
-
- Required: Yes
- Type: string
Default handling for logs that don't match any of the specified filtering conditions.
- Filters
-
- Required: Yes
- Type: Array of Filter structures
The filters that you want to apply to the logs.
ManagedProductDescriptor
Description
The properties of a managed product, such as an Amazon Web Services Managed Rules rule group or an Amazon Web Services Marketplace managed rule group.
Members
- IsAdvancedManagedRuleSet
-
- Type: boolean
Indicates whether the rule group provides an advanced set of protections, such as the the Amazon Web Services Managed Rules rule groups that are used for WAF intelligent threat mitigation.
- IsVersioningSupported
-
- Type: boolean
Indicates whether the rule group is versioned.
- ManagedRuleSetName
-
- Type: string
The name of the managed rule group. For example,
AWSManagedRulesAnonymousIpList
orAWSManagedRulesATPRuleSet
. - ProductDescription
-
- Type: string
A short description of the managed rule group.
- ProductId
-
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- ProductLink
-
- Type: string
For Amazon Web Services Marketplace managed rule groups only, the link to the rule group product page.
- ProductTitle
-
- Type: string
The display name for the managed rule group. For example,
Anonymous IP list
orAccount takeover prevention
. - SnsTopicArn
-
- Type: string
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
- VendorName
-
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
ManagedRuleGroupConfig
Description
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
-
Use the
AWSManagedRulesACFPRuleSet
configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields. -
Use the
AWSManagedRulesATPRuleSet
configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. -
Use the
AWSManagedRulesBotControlRuleSet
configuration object to configure the protection level that you want the Bot Control rule group to use.
For example specifications, see the examples section of CreateWebACL.
Members
- AWSManagedRulesACFPRuleSet
-
- Type: AWSManagedRulesACFPRuleSet structure
Additional configuration for using the account creation fraud prevention (ACFP) managed rule group,
AWSManagedRulesACFPRuleSet
. Use this to provide account creation request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to account creation requests.For information about using the ACFP managed rule group, see WAF Fraud Control account creation fraud prevention (ACFP) rule group and WAF Fraud Control account creation fraud prevention (ACFP) in the WAF Developer Guide.
- AWSManagedRulesATPRuleSet
-
- Type: AWSManagedRulesATPRuleSet structure
Additional configuration for using the account takeover prevention (ATP) managed rule group,
AWSManagedRulesATPRuleSet
. Use this to provide login request information to the rule group. For web ACLs that protect CloudFront distributions, use this to also provide the information about how your distribution responds to login requests.This configuration replaces the individual configuration fields in
ManagedRuleGroupConfig
and provides additional feature configuration.For information about using the ATP managed rule group, see WAF Fraud Control account takeover prevention (ATP) rule group and WAF Fraud Control account takeover prevention (ATP) in the WAF Developer Guide.
- AWSManagedRulesBotControlRuleSet
-
- Type: AWSManagedRulesBotControlRuleSet structure
Additional configuration for using the Bot Control managed rule group. Use this to specify the inspection level that you want to use. For information about using the Bot Control managed rule group, see WAF Bot Control rule group and WAF Bot Control in the WAF Developer Guide.
- LoginPath
-
- Type: string
Instead of this setting, provide your configuration under
AWSManagedRulesATPRuleSet
. - PasswordField
-
- Type: PasswordField structure
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
. - PayloadType
-
- Type: string
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
. - UsernameField
-
- Type: UsernameField structure
Instead of this setting, provide your configuration under the request inspection configuration for
AWSManagedRulesATPRuleSet
orAWSManagedRulesACFPRuleSet
.
ManagedRuleGroupStatement
Description
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement
, for example for use inside a NotStatement
or OrStatement
. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.
You are charged additional fees when you use the WAF Bot Control managed rule group AWSManagedRulesBotControlRuleSet
, the WAF Fraud Control account takeover prevention (ATP) managed rule group AWSManagedRulesATPRuleSet
, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule group AWSManagedRulesACFPRuleSet
. For more information, see WAF Pricing.
Members
- ExcludedRules
-
- Type: Array of ExcludedRule structures
Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
. - ManagedRuleGroupConfigs
-
- Type: Array of ManagedRuleGroupConfig structures
Additional information that's used by a managed rule group. Many managed rule groups don't require this.
The rule groups used for intelligent threat mitigation require additional configuration:
-
Use the
AWSManagedRulesACFPRuleSet
configuration object to configure the account creation fraud prevention managed rule group. The configuration includes the registration and sign-up pages of your application and the locations in the account creation request payload of data, such as the user email and phone number fields. -
Use the
AWSManagedRulesATPRuleSet
configuration object to configure the account takeover prevention managed rule group. The configuration includes the sign-in page of your application and the locations in the login request payload of data such as the username and password. -
Use the
AWSManagedRulesBotControlRuleSet
configuration object to configure the protection level that you want the Bot Control rule group to use.
- Name
-
- Required: Yes
- Type: string
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- RuleActionOverrides
-
- Type: Array of RuleActionOverride structures
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to
Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic. - ScopeDownStatement
-
- Type: Statement structure
An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
- VendorName
-
- Required: Yes
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- Version
-
- Type: string
The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
ManagedRuleGroupSummary
Description
High-level information about a managed rule group, returned by ListAvailableManagedRuleGroups. This provides information like the name and vendor name, that you provide when you add a ManagedRuleGroupStatement to a web ACL. Managed rule groups include Amazon Web Services Managed Rules rule groups and Amazon Web Services Marketplace managed rule groups. To use any Amazon Web Services Marketplace managed rule group, first subscribe to the rule group through Amazon Web Services Marketplace.
Members
- Description
-
- Type: string
The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
- Name
-
- Type: string
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
- VendorName
-
- Type: string
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.
- VersioningSupported
-
- Type: boolean
Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
ManagedRuleGroupVersion
Description
Describes a single version of a managed rule group.
Members
- LastUpdateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The date and time that the managed rule group owner updated the rule group version information.
- Name
-
- Type: string
The version name.
ManagedRuleSet
Description
A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the set that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list
. You provide it to operations likeget
andupdate
. - LabelNamespace
-
- Type: string
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
-
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
: -
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- Name
-
- Required: Yes
- Type: string
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
- PublishedVersions
-
- Type: Associative array of custom strings keys (VersionKeyString) to ManagedRuleSetVersion structures
The versions of this managed rule set that are available for use by customers.
- RecommendedVersion
-
- Type: string
The version that you would like your customers to use.
ManagedRuleSetSummary
Description
High-level information for a managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the set that helps with identification.
- Id
-
- Type: string
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list
. You provide it to operations likeget
andupdate
. - LabelNamespace
-
- Type: string
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
-
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
: -
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Type: string
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
ManagedRuleSetVersion
Description
Information for a single version of a managed rule set.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Members
- AssociatedRuleGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.
- Capacity
-
- Type: long (int|float)
The web ACL capacity units (WCUs) required for this rule group.
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.
- ExpiryTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that this version is set to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
- ForecastedLifetime
-
- Type: int
The amount of time you expect this version of your managed rule group to last, in days.
- LastUpdateTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The last time that you updated this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
- PublishTimestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time that you first published this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Method
Description
Inspect the HTTP method of the web request. The method indicates the type of operation that the request is asking the origin to perform.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: "Method": {}
Members
MobileSdkRelease
Description
Information for a release of the mobile SDK, including release notes and tags.
The mobile SDK is not generally available. Customers who have access to the mobile SDK can use it to establish and manage WAF tokens for use in HTTP(S) requests from a mobile device to WAF. For more information, see WAF client application integration in the WAF Developer Guide.
Members
- ReleaseNotes
-
- Type: string
Notes describing the release.
- ReleaseVersion
-
- Type: string
The release version.
- Tags
-
- Type: Array of Tag structures
Tags that are associated with the release.
- Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the release.
NoneAction
Description
Specifies that WAF should do nothing. This is used for the OverrideAction
setting on a Rule when the rule uses a rule group reference statement.
This is used in the context of other settings, for example to specify values for RuleAction and web ACL DefaultAction.
JSON specification: "None": {}
Members
NotStatement
OrStatement
Description
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement
.
Members
- Statements
-
- Required: Yes
- Type: Array of Statement structures
The statements to combine with OR logic. You can use any statements that can be nested.
OverrideAction
Description
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like RuleGroupReferenceStatement
and ManagedRuleGroupStatement
.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with Count
action, in your rule group reference statement settings.
Members
- Count
-
- Type: CountAction structure
Override the rule group evaluation result to count only.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
Count
action, in your rule group reference statement settings. - None
-
- Type: NoneAction structure
Don't override the rule group evaluation result. This is the most common setting.
PasswordField
Description
The name of the field in the request payload that contains your customer's password.
This data type is used in the RequestInspection
and RequestInspectionACFP
data types.
Members
- Identifier
-
- Required: Yes
- Type: string
The name of the password field.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.
PhoneNumberField
Description
The name of a field in the request payload that contains part or all of your customer's primary phone number.
This data type is used in the RequestInspectionACFP
data type.
Members
- Identifier
-
- Required: Yes
- Type: string
The name of a single primary phone number field.
How you specify the phone number fields depends on the request inspection payload type.
-
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.
QueryString
Description
Inspect the query string of the web request. This is the part of a URL that appears after a ?
character, if any.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: "QueryString": {}
Members
RateBasedStatement
Description
A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
-
IP address 10.1.1.1, HTTP method POST
-
IP address 10.1.1.1, HTTP method GET
-
IP address 127.0.0.0, HTTP method POST
-
IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
-
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
-
IP address 10.1.1.1: count 3
-
IP address 127.0.0.0: count 1
-
-
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
-
HTTP method POST: count 2
-
HTTP method GET: count 2
-
-
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
-
IP address 10.1.1.1, HTTP method POST: count 1
-
IP address 10.1.1.1, HTTP method GET: count 2
-
IP address 127.0.0.0, HTTP method POST: count 1
-
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a RateBasedStatement
inside another statement, for example inside a NotStatement
or OrStatement
. You can define a RateBasedStatement
inside a web ACL and inside a rule group.
For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
Members
- AggregateKeyType
-
- Required: Yes
- Type: string
Setting that indicates how to aggregate the request counts.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
-
CONSTANT
- Count and limit the requests that match the rate-based rule's scope-down statement. With this option, the counted requests aren't further aggregated. The scope-down statement is the only specification used. When the count of all requests that satisfy the scope-down statement goes over the limit, WAF applies the rule action to all requests that satisfy the scope-down statement.With this option, you must configure the
ScopeDownStatement
property. -
CUSTOM_KEYS
- Aggregate the request counts using one or more web request components as the aggregate keys.With this option, you must specify the aggregate keys in the
CustomKeys
property.To aggregate on only the IP address or only the forwarded IP address, don't use custom keys. Instead, set the aggregate key type to
IP
orFORWARDED_IP
. -
FORWARDED_IP
- Aggregate the request counts on the first IP address in an HTTP header.With this option, you must specify the header to use in the
ForwardedIPConfig
property.To aggregate on a combination of the forwarded IP address with other aggregate keys, use
CUSTOM_KEYS
. -
IP
- Aggregate the request counts on the IP address from the web request origin.To aggregate on a combination of the IP address with other aggregate keys, use
CUSTOM_KEYS
.
- CustomKeys
-
- Type: Array of RateBasedStatementCustomKey structures
Specifies the aggregate keys to use in a rate-base rule.
- EvaluationWindowSec
-
- Type: long (int|float)
The amount of time, in seconds, that WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when WAF checks the rate, it counts the requests for the 2 minutes immediately preceding the current time. Valid settings are 60, 120, 300, and 600.
This setting doesn't determine how often WAF checks the rate, but how far back it looks each time it checks. WAF checks the rate about every 10 seconds.
Default:
300
(5 minutes) - ForwardedIPConfig
-
- Type: ForwardedIPConfig structure
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This is required if you specify a forwarded IP in the rule's aggregate key settings.
- Limit
-
- Required: Yes
- Type: long (int|float)
The limit on requests per 5-minute period for a single aggregation instance for the rate-based rule. If the rate-based statement includes a
ScopeDownStatement
, this limit is applied only to the requests that match the statement.Examples:
-
If you aggregate on just the IP address, this is the limit on requests from any single IP address.
-
If you aggregate on the HTTP method and the query argument name "city", then this is the limit on requests for any single method, city pair.
- ScopeDownStatement
-
- Type: Statement structure
An optional nested statement that narrows the scope of the web requests that are evaluated and managed by the rate-based statement. When you use a scope-down statement, the rate-based rule only tracks and rate limits requests that match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
RateBasedStatementCustomKey
Description
Specifies a single custom aggregate key for a rate-base rule.
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling.
Members
- Cookie
-
- Type: RateLimitCookie structure
Use the value of a cookie in the request as an aggregate key. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
- ForwardedIP
-
- Type: RateLimitForwardedIP structure
Use the first IP address in an HTTP header as an aggregate key. Each distinct forwarded IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying
FORWARDED_IP
in your rate-based statement'sAggregateKeyType
.With this option, you must specify the header to use in the rate-based rule's
ForwardedIPConfig
property. - HTTPMethod
-
- Type: RateLimitHTTPMethod structure
Use the request's HTTP method as an aggregate key. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
- Header
-
- Type: RateLimitHeader structure
Use the value of a header in the request as an aggregate key. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
- IP
-
- Type: RateLimitIP structure
Use the request's originating IP address as an aggregate key. Each distinct IP address contributes to the aggregation instance.
When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the IP address by specifying
IP
in your rate-based statement'sAggregateKeyType
. - LabelNamespace
-
- Type: RateLimitLabelNamespace structure
Use the specified label namespace as an aggregate key. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.
- QueryArgument
-
- Type: RateLimitQueryArgument structure
Use the specified query argument as an aggregate key. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
- QueryString
-
- Type: RateLimitQueryString structure
Use the request's query string as an aggregate key. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
- UriPath
-
- Type: RateLimitUriPath structure
Use the request's URI path as an aggregate key. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
RateBasedStatementManagedKeysIPSet
Description
The set of IP addresses that are currently blocked for a RateBasedStatement. This is only available for rate-based rules that aggregate on just the IP address, with the AggregateKeyType
set to IP
or FORWARDED_IP
.
A rate-based rule applies its rule action to requests from IP addresses that are in the rule's managed keys list and that match the rule's scope-down statement. When a rule has no scope-down statement, it applies the action to all requests from the IP addresses that are in the list. The rule applies its rule action to rate limit the matching requests. The action is usually Block but it can be any valid rule action except for Allow.
The maximum number of IP addresses that can be rate limited by a single rate-based rule instance is 10,000. If more than 10,000 addresses exceed the rate limit, WAF limits those with the highest rates.
Members
- Addresses
-
- Type: Array of strings
The IP addresses that are currently blocked.
- IPAddressVersion
-
- Type: string
The version of the IP addresses, either
IPV4
orIPV6
.
RateLimitCookie
Description
Specifies a cookie as an aggregate key for a rate-based rule. Each distinct value in the cookie contributes to the aggregation instance. If you use a single cookie as your custom key, then each value fully defines an aggregation instance.
Members
- Name
-
- Required: Yes
- Type: string
The name of the cookie to use.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RateLimitForwardedIP
Description
Specifies the first IP address in an HTTP header as an aggregate key for a rate-based rule. Each distinct forwarded IP address contributes to the aggregation instance.
This setting is used only in the RateBasedStatementCustomKey
specification of a rate-based rule statement. When you specify an IP or forwarded IP in the custom key settings, you must also specify at least one other key to use. You can aggregate on only the forwarded IP address by specifying FORWARDED_IP
in your rate-based statement's AggregateKeyType
.
This data type supports using the forwarded IP address in the web request aggregation for a rate-based rule, in RateBasedStatementCustomKey
. The JSON specification for using the forwarded IP address doesn't explicitly use this data type.
JSON specification: "ForwardedIP": {}
When you use this specification, you must also configure the forwarded IP address in the rate-based statement's ForwardedIPConfig
.
Members
RateLimitHTTPMethod
Description
Specifies the request's HTTP method as an aggregate key for a rate-based rule. Each distinct HTTP method contributes to the aggregation instance. If you use just the HTTP method as your custom key, then each method fully defines an aggregation instance.
JSON specification: "RateLimitHTTPMethod": {}
Members
RateLimitHeader
Description
Specifies a header as an aggregate key for a rate-based rule. Each distinct value in the header contributes to the aggregation instance. If you use a single header as your custom key, then each value fully defines an aggregation instance.
Members
- Name
-
- Required: Yes
- Type: string
The name of the header to use.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RateLimitIP
Description
Specifies the IP address in the web request as an aggregate key for a rate-based rule. Each distinct IP address contributes to the aggregation instance.
This setting is used only in the RateBasedStatementCustomKey
specification of a rate-based rule statement. To use this in the custom key settings, you must specify at least one other key to use, along with the IP address. To aggregate on only the IP address, in your rate-based statement's AggregateKeyType
, specify IP
.
JSON specification: "RateLimitIP": {}
Members
RateLimitLabelNamespace
Description
Specifies a label namespace to use as an aggregate key for a rate-based rule. Each distinct fully qualified label name that has the specified label namespace contributes to the aggregation instance. If you use just one label namespace as your custom key, then each label name fully defines an aggregation instance.
This uses only labels that have been added to the request by rules that are evaluated before this rate-based rule in the web ACL.
For information about label namespaces and names, see Label syntax and naming requirements in the WAF Developer Guide.
Members
- Namespace
-
- Required: Yes
- Type: string
The namespace to use for aggregation.
RateLimitQueryArgument
Description
Specifies a query argument in the request as an aggregate key for a rate-based rule. Each distinct value for the named query argument contributes to the aggregation instance. If you use a single query argument as your custom key, then each value fully defines an aggregation instance.
Members
- Name
-
- Required: Yes
- Type: string
The name of the query argument to use.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RateLimitQueryString
Description
Specifies the request's query string as an aggregate key for a rate-based rule. Each distinct string contributes to the aggregation instance. If you use just the query string as your custom key, then each string fully defines an aggregation instance.
Members
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RateLimitUriPath
Description
Specifies the request's URI path as an aggregate key for a rate-based rule. Each distinct URI path contributes to the aggregation instance. If you use just the URI path as your custom key, then each URI path fully defines an aggregation instance.
Members
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Regex
Description
A single regular expression. This is used in a RegexPatternSet.
Members
- RegexString
-
- Type: string
The string representing the regular expression.
RegexMatchStatement
Description
A rule statement used to search web request components for a match against a single regular expression.
Members
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- RegexString
-
- Required: Yes
- Type: string
The string representing the regular expression.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RegexPatternSet
Description
Contains one or more regular expressions.
WAF assigns an ARN to each RegexPatternSet
that you create. To use a set in a rule, you provide the ARN to the Rule statement RegexPatternSetReferenceStatement.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the set that helps with identification.
- Id
-
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- Name
-
- Type: string
The name of the set. You cannot change the name after you create the set.
- RegularExpressionList
-
- Type: Array of Regex structures
The regular expression patterns in the set.
RegexPatternSetReferenceStatement
Description
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
RegexPatternSetSummary
Description
High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet
, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the set that helps with identification.
- Id
-
- Type: string
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Type: string
The name of the data type instance. You cannot change the name after you create the instance.
ReleaseSummary
Description
High level information for an SDK release.
Members
- ReleaseVersion
-
- Type: string
The release version.
- Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp of the release.
RequestBodyAssociatedResourceTypeConfig
Description
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types.
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
Example JSON: { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
This is used in the AssociationConfig
of the web ACL.
Members
- DefaultSizeInspectionLimit
-
- Required: Yes
- Type: string
Specifies the maximum size of the web request body component that an associated CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resource should send to WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.
Default:
16 KB (16,384 bytes)
RequestInspection
Description
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.
This is part of the AWSManagedRulesATPRuleSet
configuration in ManagedRuleGroupConfig
.
In these settings, you specify how your application accepts login attempts by providing the request payload type and the names of the fields within the request body where the username and password are provided.
Members
- PasswordField
-
- Required: Yes
- Type: PasswordField structure
The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.
- PayloadType
-
- Required: Yes
- Type: string
The payload type for your login endpoint, either JSON or form encoded.
- UsernameField
-
- Required: Yes
- Type: UsernameField structure
The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
RequestInspectionACFP
Description
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.
This is part of the AWSManagedRulesACFPRuleSet
configuration in ManagedRuleGroupConfig
.
In these settings, you specify how your application accepts account creation attempts by providing the request payload type and the names of the fields within the request body where the username, password, email, and primary address and phone number fields are provided.
Members
- AddressFields
-
- Type: Array of AddressField structures
The names of the fields in the request payload that contain your customer's primary physical address.
Order the address fields in the array exactly as they are ordered in the request payload.
How you specify the address fields depends on the request inspection payload type.
-
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "primaryaddressline1": "THE_ADDRESS1", "primaryaddressline2": "THE_ADDRESS2", "primaryaddressline3": "THE_ADDRESS3" } }
, the address field idenfiers are/form/primaryaddressline1
,/form/primaryaddressline2
, and/form/primaryaddressline3
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
, the address fields identifiers areprimaryaddressline1
,primaryaddressline2
, andprimaryaddressline3
.
- EmailField
-
- Type: EmailField structure
The name of the field in the request payload that contains your customer's email.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "email": "THE_EMAIL" } }
, the email field specification is/form/email
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
email1
, the email field specification isemail1
.
- PasswordField
-
- Type: PasswordField structure
The name of the field in the request payload that contains your customer's password.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "password": "THE_PASSWORD" } }
, the password field specification is/form/password
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
password1
, the password field specification ispassword1
.
- PayloadType
-
- Required: Yes
- Type: string
The payload type for your account creation endpoint, either JSON or form encoded.
- PhoneNumberFields
-
- Type: Array of PhoneNumberField structures
The names of the fields in the request payload that contain your customer's primary phone number.
Order the phone number fields in the array exactly as they are ordered in the request payload.
How you specify the phone number fields depends on the request inspection payload type.
-
For JSON payloads, specify the field identifiers in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "primaryphoneline1": "THE_PHONE1", "primaryphoneline2": "THE_PHONE2", "primaryphoneline3": "THE_PHONE3" } }
, the phone number field identifiers are/form/primaryphoneline1
,/form/primaryphoneline2
, and/form/primaryphoneline3
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with input elements named
primaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
, the phone number field identifiers areprimaryphoneline1
,primaryphoneline2
, andprimaryphoneline3
.
- UsernameField
-
- Type: UsernameField structure
The name of the field in the request payload that contains your customer's username.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
ResponseInspection
Description
The criteria for inspecting responses to login requests and account creation requests, used by the ATP and ACFP rule groups to track login and account creation success and failure rates.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
The rule groups evaluates the responses that your protected resources send back to client login and account creation attempts, keeping count of successful and failed attempts from each IP address and client session. Using this information, the rule group labels and mitigates requests from client sessions and IP addresses with too much suspicious activity in a short amount of time.
This is part of the AWSManagedRulesATPRuleSet
and AWSManagedRulesACFPRuleSet
configurations in ManagedRuleGroupConfig
.
Enable response inspection by configuring exactly one component of the response to inspect, for example, Header
or StatusCode
. You can't configure more than one component for inspection. If you don't configure any of the response inspection options, response inspection is disabled.
Members
- BodyContains
-
- Type: ResponseInspectionBodyContains structure
Configures inspection of the response body for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response body.
- Header
-
- Type: ResponseInspectionHeader structure
Configures inspection of the response header for success and failure indicators.
- Json
-
- Type: ResponseInspectionJson structure
Configures inspection of the response JSON for success and failure indicators. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.
- StatusCode
-
- Type: ResponseInspectionStatusCode structure
Configures inspection of the response status code for success and failure indicators.
ResponseInspectionBodyContains
Description
Configures inspection of the response body. WAF can inspect the first 65,536 bytes (64 KB) of the response body. This is part of the ResponseInspection
configuration for AWSManagedRulesATPRuleSet
and AWSManagedRulesACFPRuleSet
.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
Members
- FailureStrings
-
- Required: Yes
- Type: Array of strings
Strings in the body of the response that indicate a failed login or account creation attempt. To be counted as a failure, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON example:
"FailureStrings": [ "Request failed" ]
- SuccessStrings
-
- Required: Yes
- Type: Array of strings
Strings in the body of the response that indicate a successful login or account creation attempt. To be counted as a success, the string can be anywhere in the body and must be an exact match, including case. Each string must be unique among the success and failure strings.
JSON examples:
"SuccessStrings": [ "Login successful" ]
and"SuccessStrings": [ "Account creation successful", "Welcome to our site!" ]
ResponseInspectionHeader
Description
Configures inspection of the response header. This is part of the ResponseInspection
configuration for AWSManagedRulesATPRuleSet
and AWSManagedRulesACFPRuleSet
.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
Members
- FailureValues
-
- Required: Yes
- Type: Array of strings
Values in the response header with the specified name that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"FailureValues": [ "LoginFailed", "Failed login" ]
and"FailureValues": [ "AccountCreationFailed" ]
- Name
-
- Required: Yes
- Type: string
The name of the header to match against. The name must be an exact match, including case.
JSON example:
"Name": [ "RequestResult" ]
- SuccessValues
-
- Required: Yes
- Type: Array of strings
Values in the response header with the specified name that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON examples:
"SuccessValues": [ "LoginPassed", "Successful login" ]
and"SuccessValues": [ "AccountCreated", "Successful account creation" ]
ResponseInspectionJson
Description
Configures inspection of the response JSON. WAF can inspect the first 65,536 bytes (64 KB) of the response JSON. This is part of the ResponseInspection
configuration for AWSManagedRulesATPRuleSet
and AWSManagedRulesACFPRuleSet
.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
Members
- FailureValues
-
- Required: Yes
- Type: Array of strings
Values for the specified identifier in the response JSON that indicate a failed login or account creation attempt. To be counted as a failure, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"FailureValues": [ "False", "Failed" ]
- Identifier
-
- Required: Yes
- Type: string
The identifier for the value to match against in the JSON. The identifier must be an exact match, including case.
JSON examples:
"Identifier": [ "/login/success" ]
and"Identifier": [ "/sign-up/success" ]
- SuccessValues
-
- Required: Yes
- Type: Array of strings
Values for the specified identifier in the response JSON that indicate a successful login or account creation attempt. To be counted as a success, the value must be an exact match, including case. Each value must be unique among the success and failure values.
JSON example:
"SuccessValues": [ "True", "Succeeded" ]
ResponseInspectionStatusCode
Description
Configures inspection of the response status code. This is part of the ResponseInspection
configuration for AWSManagedRulesATPRuleSet
and AWSManagedRulesACFPRuleSet
.
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.
Members
- FailureCodes
-
- Required: Yes
- Type: Array of ints
Status codes in the response that indicate a failed login or account creation attempt. To be counted as a failure, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"FailureCodes": [ 400, 404 ]
- SuccessCodes
-
- Required: Yes
- Type: Array of ints
Status codes in the response that indicate a successful login or account creation attempt. To be counted as a success, the response status code must match one of these. Each code must be unique among the success and failure status codes.
JSON example:
"SuccessCodes": [ 200, 201 ]
Rule
Description
A single rule, which you can use in a WebACL or RuleGroup to identify web requests that you want to manage in some way. Each rule includes one top-level Statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
Members
- Action
-
- Type: RuleAction structure
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule group include
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.You must specify either this
Action
setting or the ruleOverrideAction
setting, but not both:-
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
-
If the rule statement references a rule group, use the override action setting and not this action setting.
- CaptchaConfig
-
- Type: CaptchaConfig structure
Specifies how WAF should handle
CAPTCHA
evaluations. If you don't specify this, WAF uses theCAPTCHA
configuration that's defined for the web ACL. - ChallengeConfig
-
- Type: ChallengeConfig structure
Specifies how WAF should handle
Challenge
evaluations. If you don't specify this, WAF uses the challenge configuration that's defined for the web ACL. - Name
-
- Required: Yes
- Type: string
The name of the rule.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name in the rule'sVisibilityConfig
settings. WAF doesn't automatically update the metric name when you update the rule name. - OverrideAction
-
- Type: OverrideAction structure
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatement
andManagedRuleGroupStatement
.This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead use the rule action override option, with
Count
action, in your rule group reference statement settings. - Priority
-
- Required: Yes
- Type: int
If you define more than one
Rule
in aWebACL
, WAF evaluates each request against theRules
in order based on the value ofPriority
. WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different. - RuleLabels
-
- Type: Array of Label structures
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a
LabelMatchStatement
.For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
-
Separate each component of the label with a colon.
-
Each namespace or name can have up to 128 characters.
-
You can specify up to 5 namespaces in a label.
-
Don't use the following reserved words in your label specification:
aws
,waf
,managed
,rulegroup
,webacl
,regexpatternset
, oripset
.
For example,
myLabelName
ornameSpace1:nameSpace2:myLabelName
. - Statement
-
- Required: Yes
- Type: Statement structure
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
If you change the name of a
Rule
after you create it and you want the rule's metric name to reflect the change, update the metric name as well. WAF doesn't automatically update the metric name.
RuleAction
Description
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
Members
- Allow
-
- Type: AllowAction structure
Instructs WAF to allow the web request.
- Block
-
- Type: BlockAction structure
Instructs WAF to block the web request.
- Captcha
-
- Type: CaptchaAction structure
Instructs WAF to run a
CAPTCHA
check against the web request. - Challenge
-
- Type: ChallengeAction structure
Instructs WAF to run a
Challenge
check against the web request. - Count
-
- Type: CountAction structure
Instructs WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.
RuleActionOverride
Description
Action setting to use in the place of a rule action that is configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
Members
- ActionToUse
-
- Required: Yes
- Type: RuleAction structure
The override action to use, in place of the configured action of the rule in the rule group.
- Name
-
- Required: Yes
- Type: string
The name of the rule to override.
RuleGroup
Description
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.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the entity.
- AvailableLabels
-
- Type: Array of LabelSummary structures
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the
RuleLabels
for a Rule. - Capacity
-
- Required: Yes
- Type: long (int|float)
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.
- ConsumedLabels
-
- Type: Array of LabelSummary structures
The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a
LabelMatchStatement
specification, in the Statement definition of a rule. - CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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.
- Description
-
- Type: string
A description of the rule group that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LabelNamespace
-
- Type: string
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
-
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group name>:
-
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- Name
-
- Required: Yes
- Type: string
The name of the rule group. You cannot change the name of a rule group after you create it.
- Rules
-
- Type: Array of Rule structures
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.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
RuleGroupReferenceStatement
Description
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement
, for example for use inside a NotStatement
or OrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the entity.
- ExcludedRules
-
- Type: Array of ExcludedRule structures
Rules in the referenced rule group whose actions are set to
Count
.Instead of this option, use
RuleActionOverrides
. It accepts any valid action setting, includingCount
. - RuleActionOverrides
-
- Type: Array of RuleActionOverride structures
Action settings to use in the place of the rule actions that are configured inside the rule group. You specify one override for each rule whose action you want to change.
You can use overrides for testing, for example you can override all of rule actions to
Count
and then monitor the resulting count metrics to understand how the rule group would handle your web traffic. You can also permanently override some or all actions, to modify how the rule group manages your web traffic.
RuleGroupSummary
Description
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.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the rule group that helps with identification.
- Id
-
- Type: string
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Type: string
The name of the data type instance. You cannot change the name after you create the instance.
RuleSummary
Description
High-level information about a Rule, returned by operations like DescribeManagedRuleGroup. 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.
Members
- Action
-
- Type: RuleAction structure
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
- Name
-
- Type: string
The name of the rule.
SampledHTTPRequest
Description
Represents a single sampled web request. The response from GetSampledRequests includes a SampledHTTPRequests
complex type that appears as SampledRequests
in the response syntax. SampledHTTPRequests
contains an array of SampledHTTPRequest
objects.
Members
- Action
-
- Type: string
The action that WAF applied to the request.
- CaptchaResponse
-
- Type: CaptchaResponse structure
The
CAPTCHA
response for the request. - ChallengeResponse
-
- Type: ChallengeResponse structure
The
Challenge
response for the request. - Labels
-
- Type: Array of Label structures
Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
For example,
awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA
orawswaf:managed:aws:managed-rule-set:header:encoding:utf8
. - OverriddenAction
-
- Type: string
Used only for rule group rules that have a rule action override in place in the web ACL. This is the action that the rule group rule is configured for, and not the action that was applied to the request. The action that WAF applied is the
Action
value. - Request
-
- Required: Yes
- Type: HTTPRequest structure
A complex type that contains detailed information about the request.
- RequestHeadersInserted
-
- Type: Array of HTTPHeader structures
Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
- ResponseCodeSent
-
- Type: int
The response code that was sent for the request.
- RuleNameWithinRuleGroup
-
- Type: string
The name of the
Rule
that the request matched. For managed rule groups, the format for this name is<vendor name>#<managed rule group name>#<rule name>
. For your own rule groups, the format for this name is<rule group name>#<rule name>
. If the rule is not in a rule group, this field is absent. - Timestamp
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
- Weight
-
- Required: Yes
- Type: long (int|float)
A value that indicates how one result in the response relates proportionally to other results in the response. For example, a result that has a weight of
2
represents roughly twice as many web requests as a result that has a weight of1
.
SingleHeader
Description
Inspect one of the headers in the web request, identified by name, for example, User-Agent
or Referer
. The name isn't case sensitive.
You can filter and inspect all headers with the FieldToMatch
setting Headers
.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: "SingleHeader": { "Name": "haystack" }
Members
- Name
-
- Required: Yes
- Type: string
The name of the query header to inspect.
SingleQueryArgument
Description
Inspect one query argument in the web request, identified by name, for example UserName or SalesRegion. The name isn't case sensitive.
This is used to indicate the web request component to inspect, in the FieldToMatch specification.
Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
Members
- Name
-
- Required: Yes
- Type: string
The name of the query argument to inspect.
SizeConstraintStatement
Description
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see Body
and JsonBody
settings for the FieldToMatch
data type.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI /logo.jpg
is nine characters long.
Members
- ComparisonOperator
-
- Required: Yes
- Type: string
The operator to use to compare the request part to the size setting.
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- Size
-
- Required: Yes
- Type: long (int|float)
The size, in byte, to compare to the request part, after any transformations.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
SqliMatchStatement
Description
A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
Members
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- SensitivityLevel
-
- Type: string
The sensitivity that you want WAF to use to inspect for SQL injection attacks.
HIGH
detects more attacks, but might generate more false positives, especially if your web requests frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the WAF Developer Guide.LOW
is generally a better choice for resources that already have other protections against SQL injection attacks or that have a low tolerance for false positives.Default:
LOW
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.
Statement
Description
The processing guidance for a Rule, used by WAF to determine whether a web request matches the rule.
For example specifications, see the examples section of CreateWebACL.
Members
- AndStatement
-
- Type: AndStatement structure
A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the
AndStatement
. - ByteMatchStatement
-
- Type: ByteMatchStatement structure
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.
- GeoMatchStatement
-
- Type: GeoMatchStatement structure
A rule statement that labels web requests by country and region and that matches against web requests based on country code. A geo match rule labels every request that it inspects regardless of whether it finds a match.
-
To manage requests only by country, you can use this statement by itself and specify the countries that you want to match against in the
CountryCodes
array. -
Otherwise, configure your geo match rule with Count action so that it only labels requests. Then, add one or more label match rules to run after the geo match rule and configure them to match against the geographic labels and handle the requests as needed.
WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. WAF determines the codes using either the IP address in the web request origin or, if you specify it, the address in the geo match
ForwardedIPConfig
.If you use the web request origin, the label formats are
awswaf:clientip:geo:region:<ISO country code>-<ISO region code>
andawswaf:clientip:geo:country:<ISO country code>
.If you use a forwarded IP address, the label formats are
awswaf:forwardedip:geo:region:<ISO country code>-<ISO region code>
andawswaf:forwardedip:geo:country:<ISO country code>
.For additional details, see Geographic match rule statement in the WAF Developer Guide.
- IPSetReferenceStatement
-
- Type: IPSetReferenceStatement structure
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
- LabelMatchStatement
-
- Type: LabelMatchStatement structure
A rule statement to match against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
- ManagedRuleGroupStatement
-
- Type: ManagedRuleGroupStatement structure
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a
ManagedRuleGroupStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a managed rule group inside another rule group. You can only reference a managed rule group as a top-level statement within a rule that you define in a web ACL.You are charged additional fees when you use the WAF Bot Control managed rule group
AWSManagedRulesBotControlRuleSet
, the WAF Fraud Control account takeover prevention (ATP) managed rule groupAWSManagedRulesATPRuleSet
, or the WAF Fraud Control account creation fraud prevention (ACFP) managed rule groupAWSManagedRulesACFPRuleSet
. For more information, see WAF Pricing. - NotStatement
-
- Type: NotStatement structure
A logical rule statement used to negate the results of another rule statement. You provide one Statement within the
NotStatement
. - OrStatement
-
- Type: OrStatement structure
A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the
OrStatement
. - RateBasedStatement
-
- Type: RateBasedStatement structure
A rate-based rule counts incoming requests and rate limits requests when they are coming at too fast a rate. The rule categorizes requests according to your aggregation criteria, collects them into aggregation instances, and counts and rate limits the requests for each instance.
If you change any of these settings in a rule that's currently in use, the change resets the rule's rate limiting counts. This can pause the rule's rate limiting activities for up to a minute.
You can specify individual aggregation keys, like IP address or HTTP method. You can also specify aggregation key combinations, like IP address and HTTP method, or HTTP method, query argument, and cookie.
Each unique set of values for the aggregation keys that you specify is a separate aggregation instance, with the value from each key contributing to the aggregation instance definition.
For example, assume the rule evaluates web requests with the following IP address and HTTP method values:
-
IP address 10.1.1.1, HTTP method POST
-
IP address 10.1.1.1, HTTP method GET
-
IP address 127.0.0.0, HTTP method POST
-
IP address 10.1.1.1, HTTP method GET
The rule would create different aggregation instances according to your aggregation criteria, for example:
-
If the aggregation criteria is just the IP address, then each individual address is an aggregation instance, and WAF counts requests separately for each. The aggregation instances and request counts for our example would be the following:
-
IP address 10.1.1.1: count 3
-
IP address 127.0.0.0: count 1
-
-
If the aggregation criteria is HTTP method, then each individual HTTP method is an aggregation instance. The aggregation instances and request counts for our example would be the following:
-
HTTP method POST: count 2
-
HTTP method GET: count 2
-
-
If the aggregation criteria is IP address and HTTP method, then each IP address and each HTTP method would contribute to the combined aggregation instance. The aggregation instances and request counts for our example would be the following:
-
IP address 10.1.1.1, HTTP method POST: count 1
-
IP address 10.1.1.1, HTTP method GET: count 2
-
IP address 127.0.0.0, HTTP method POST: count 1
-
For any n-tuple of aggregation keys, each unique combination of values for the keys defines a separate aggregation instance, which WAF counts and rate-limits individually.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts and rate limits requests that match the nested statement. You can use this nested scope-down statement in conjunction with your aggregation key specifications or you can just count and rate limit all requests that match the scope-down statement, without additional aggregation. When you choose to just manage all requests that match a scope-down statement, the aggregation instance is singular for the rule.
You cannot nest a
RateBasedStatement
inside another statement, for example inside aNotStatement
orOrStatement
. You can define aRateBasedStatement
inside a web ACL and inside a rule group.For additional information about the options, see Rate limiting web requests using rate-based rules in the WAF Developer Guide.
If you only aggregate on the individual IP address or forwarded IP address, you can retrieve the list of IP addresses that WAF is currently rate limiting for a rule through the API call
GetRateBasedStatementManagedKeys
. This option is not available for other aggregation configurations.WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
- RegexMatchStatement
-
- Type: RegexMatchStatement structure
A rule statement used to search web request components for a match against a single regular expression.
- RegexPatternSetReferenceStatement
-
- Type: RegexPatternSetReferenceStatement structure
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
- RuleGroupReferenceStatement
-
- Type: RuleGroupReferenceStatement structure
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a
RuleGroupReferenceStatement
, for example for use inside aNotStatement
orOrStatement
. You cannot use a rule group reference statement inside another rule group. You can only reference a rule group as a top-level statement within a rule that you define in a web ACL. - SizeConstraintStatement
-
- Type: SizeConstraintStatement structure
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the number of bytes in the body up to the limit for the web ACL and protected resource type. If you know that the request body for your web requests should never exceed the inspection limit, you can use a size constraint statement to block requests that have a larger request body size. For more information about the inspection limits, see
Body
andJsonBody
settings for theFieldToMatch
data type.If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one character. For example, the URI
/logo.jpg
is nine characters long. - SqliMatchStatement
-
- Type: SqliMatchStatement structure
A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
- XssMatchStatement
-
- Type: XssMatchStatement structure
A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
Tag
Description
A tag associated with an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
Members
- Key
-
- Required: Yes
- Type: string
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
- Value
-
- Required: Yes
- Type: string
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
TagInfoForResource
Description
The collection of tagging definitions for an Amazon Web Services resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing or other management. Typically, the tag key represents a category, such as "environment", and the tag value represents a specific value within that category, such as "test," "development," or "production". Or you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
You can tag the Amazon Web Services resources that you manage through WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the WAF console.
Members
TextTransformation
Description
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection.
Members
- Priority
-
- Required: Yes
- Type: int
Sets the relative processing order for multiple transformations. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
- Type
-
- Required: Yes
- Type: string
For detailed descriptions of each of the transformation types, see Text transformations in the WAF Developer Guide.
TimeWindow
Description
In a GetSampledRequests request, the StartTime
and EndTime
objects specify the time range for which you want WAF to return a sample of web requests.
You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z
. For example, "2016-09-27T14:50Z"
. You can specify any time range in the previous three hours.
In a GetSampledRequests response, the StartTime
and EndTime
objects specify the time range for which WAF actually returned a sample of web requests. WAF gets the specified number of requests from among the first 5,000 requests that your Amazon Web Services resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, WAF stops sampling after the 5,000th request. In that case, EndTime
is the time that WAF received the 5,000th request.
Members
- EndTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The end of the time range from which you want
GetSampledRequests
to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator,Z
. For example,"2016-09-27T14:50Z"
. You can specify any time range in the previous three hours. - StartTime
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The beginning of the time range from which you want
GetSampledRequests
to return a sample of the requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator,Z
. For example,"2016-09-27T14:50Z"
. You can specify any time range in the previous three hours.
UriPath
Description
Inspect the path component of the URI of the web request. This is the part of the web request that identifies a resource. For example, /images/daily-ad.jpg
.
This is used in the FieldToMatch specification for some web request component types.
JSON specification: "UriPath": {}
Members
UsernameField
Description
The name of the field in the request payload that contains your customer's username.
This data type is used in the RequestInspection
and RequestInspectionACFP
data types.
Members
- Identifier
-
- Required: Yes
- Type: string
The name of the username field.
How you specify this depends on the request inspection payload type.
-
For JSON payloads, specify the field name in JSON pointer syntax. For information about the JSON Pointer syntax, see the Internet Engineering Task Force (IETF) documentation JavaScript Object Notation (JSON) Pointer.
For example, for the JSON payload
{ "form": { "username": "THE_USERNAME" } }
, the username field specification is/form/username
. -
For form encoded payload types, use the HTML form names.
For example, for an HTML form with the input element named
username1
, the username field specification isusername1
VersionToPublish
Description
A version of the named managed rule group, that the rule group's vendor publishes for use by customers.
This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.
Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
, PutManagedRuleSetVersions
, and UpdateManagedRuleSetVersionExpiryDate
.
Members
- AssociatedRuleGroupArn
-
- Type: string
The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version.
- ForecastedLifetime
-
- Type: int
The amount of time the vendor expects this version of the managed rule group to last, in days.
VisibilityConfig
Description
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Members
- CloudWatchMetricsEnabled
-
- Required: Yes
- Type: boolean
Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics in the WAF Developer Guide.
For web ACLs, the metrics are for web requests that have the web ACL default action applied. WAF applies the default action to web requests that pass the inspection of all rules in the web ACL without being either allowed or blocked. For more information, see The web ACL default action in the WAF Developer Guide.
- MetricName
-
- Required: Yes
- Type: string
A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for WAF, for example
All
andDefault_Action
. - SampledRequestsEnabled
-
- Required: Yes
- Type: boolean
Indicates whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. The only way to exclude fields from request sampling is by disabling sampling in the web ACL visibility configuration.
WAFAssociatedItemException
Description
WAF couldn’t perform the operation because your resource is being used by another resource or it’s associated with another resource.
Members
- Message
-
- Type: string
WAFConfigurationWarningException
Description
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 a SizeConstraintStatement
that blocks the body content from being too large. Rules that inspect the headers or cookies must provide an OversizeHandling
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
).
Members
- Message
-
- Type: string
WAFDuplicateItemException
Description
WAF couldn’t perform the operation because the resource that you tried to save is a duplicate of an existing one.
Members
- Message
-
- Type: string
WAFExpiredManagedRuleGroupVersionException
Description
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.
Members
- Message
-
- Type: string
WAFInternalErrorException
Description
Your request is valid, but WAF couldn’t perform the operation because of a system problem. Retry your request.
Members
- Message
-
- Type: string
WAFInvalidOperationException
Description
The operation isn't valid.
Members
- Message
-
- Type: string
WAFInvalidParameterException
Description
The operation failed because 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.
Members
- Field
-
- Type: string
The settings where the invalid parameter was found.
- Parameter
-
- Type: string
The invalid parameter that resulted in the exception.
- Reason
-
- Type: string
Additional information about the exception.
- message
-
- Type: string
WAFInvalidPermissionPolicyException
Description
The operation failed because the specified policy isn't in the proper format.
The policy specifications must conform to the following:
-
The policy must be composed using IAM Policy version 2012-10-17.
-
The policy must include specifications for
Effect
,Action
, andPrincipal
. -
Effect
must specifyAllow
. -
Action
must specifywafv2:CreateWebACL
,wafv2:UpdateWebACL
, andwafv2:PutFirewallManagerRuleGroups
and may optionally specifywafv2:GetRuleGroup
. WAF rejects any extra actions or wildcard actions in the policy. -
The policy must not include a
Resource
parameter.
For more information, see IAM Policies.
Members
- Message
-
- Type: string
WAFInvalidResourceException
Description
WAF couldn’t perform the operation because the resource that you requested isn’t valid. Check the resource, and try again.
Members
- Message
-
- Type: string
WAFLimitsExceededException
Description
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 Amazon Web Services account. For more information, see WAF quotas in the WAF Developer Guide.
Members
- Message
-
- Type: string
- SourceType
-
- Type: string
Source type for the exception.
WAFLogDestinationPermissionIssueException
Description
The operation failed because you don't have the permissions that your logging configuration requires. For information, see Logging web ACL traffic information in the WAF Developer Guide.
Members
- Message
-
- Type: string
WAFNonexistentItemException
Description
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.
Members
- Message
-
- Type: string
WAFOptimisticLockException
Description
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.
Members
- Message
-
- Type: string
WAFServiceLinkedRoleErrorException
Description
WAF is not able to access the service linked role. This can be caused by a previous PutLoggingConfiguration
request, which can lock the service linked role for about 20 seconds. Please try your request again. The service linked role can also be locked by a previous DeleteServiceLinkedRole
request, which can lock the role for 15 minutes or more. If you recently made a call to DeleteServiceLinkedRole
, wait at least 15 minutes and try the request again. If you receive this same exception again, you will have to wait additional time until the role is unlocked.
Members
- message
-
- Type: string
WAFSubscriptionNotFoundException
Description
You tried to use a managed rule group that's available by subscription, but you aren't subscribed to it yet.
Members
- Message
-
- Type: string
WAFTagOperationException
Description
An error occurred during the tagging operation. Retry your request.
Members
- Message
-
- Type: string
WAFTagOperationInternalErrorException
Description
WAF couldn’t perform your tagging operation because of an internal error. Retry your request.
Members
- Message
-
- Type: string
WAFUnavailableEntityException
Description
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.
Members
- Message
-
- Type: string
WAFUnsupportedAggregateKeyTypeException
Description
The rule that you've named doesn't aggregate solely on the IP address or solely on the forwarded IP address. This call is only available for rate-based rules with an AggregateKeyType
setting of IP
or FORWARDED_IP
.
Members
- Message
-
- Type: string
WebACL
Description
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 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 Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
Members
- ARN
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
- AssociationConfig
-
- Type: AssociationConfig structure
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 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).
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see WAF Pricing.
For Application Load Balancer and AppSync, the limit is fixed at 8 KB (8,192 bytes).
- Capacity
-
- Type: long (int|float)
The web ACL capacity units (WCUs) currently being used by this web ACL.
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.
- CaptchaConfig
-
- Type: CaptchaConfig structure
Specifies how WAF should handle
CAPTCHA
evaluations for rules that don't have their ownCaptchaConfig
settings. If you don't specify this, WAF uses its default settings forCaptchaConfig
. - ChallengeConfig
-
- Type: ChallengeConfig structure
Specifies how WAF should handle challenge evaluations for rules that don't have their own
ChallengeConfig
settings. If you don't specify this, WAF uses its default settings forChallengeConfig
. - CustomResponseBodies
-
- Type: Associative array of custom strings keys (EntityName) to CustomResponseBody structures
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 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.
- DefaultAction
-
- Required: Yes
- Type: DefaultAction structure
The action to perform if none of the
Rules
contained in theWebACL
match. - Description
-
- Type: string
A description of the web ACL that helps with identification.
- Id
-
- Required: Yes
- Type: string
A unique identifier for the
WebACL
. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete aWebACL
. - LabelNamespace
-
- Type: string
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
-
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
-
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
- ManagedByFirewallManager
-
- Type: boolean
Indicates whether this web ACL was created by Firewall Manager and is being managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL. See also the properties
RetrofittedByFirewallManager
,PreProcessFirewallManagerRuleGroups
, andPostProcessFirewallManagerRuleGroups
. - Name
-
- Required: Yes
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
- PostProcessFirewallManagerRuleGroups
-
- Type: Array of FirewallManagerRuleGroup structures
The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- PreProcessFirewallManagerRuleGroups
-
- Type: Array of FirewallManagerRuleGroup structures
The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
- RetrofittedByFirewallManager
-
- Type: boolean
Indicates whether this web ACL was created by a customer account and then retrofitted by Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties
ManagedByFirewallManager
,PreProcessFirewallManagerRuleGroups
, andPostProcessFirewallManagerRuleGroups
. - Rules
-
- Type: Array of Rule structures
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.
- TokenDomains
-
- Type: Array of strings
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
- VisibilityConfig
-
- Required: Yes
- Type: VisibilityConfig structure
Defines and enables Amazon CloudWatch metrics and web request sample collection.
WebACLSummary
Description
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.
Members
- ARN
-
- Type: string
The Amazon Resource Name (ARN) of the entity.
- Description
-
- Type: string
A description of the web ACL that helps with identification.
- Id
-
- Type: string
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
- LockToken
-
- Type: string
A token used for optimistic locking. WAF returns a token to your
get
andlist
requests, to mark the state of the entity at the time of the request. To make changes to the entity associated with the token, you provide the token to operations likeupdate
anddelete
. WAF uses the token to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made, the update fails with aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation. - Name
-
- Type: string
The name of the web ACL. You cannot change the name of a web ACL after you create it.
XssMatchStatement
Description
A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
Members
- FieldToMatch
-
- Required: Yes
- Type: FieldToMatch structure
The part of the web request that you want WAF to inspect.
- TextTransformations
-
- Required: Yes
- Type: Array of TextTransformation structures
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. Text transformations are used in rule match statements, to transform the
FieldToMatch
request component before inspecting it, and they're used in rate-based rule statements, to transform request components before using them as custom aggregation keys. If you specify one or more transformations to apply, WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.