# AWS WAFV2
<a name="API_Types_AWS_WAFV2"></a>

The following data types are supported by AWS WAFV2:
+  [ActionCondition](API_ActionCondition.md) 
+  [AddressField](API_AddressField.md) 
+  [All](API_All.md) 
+  [AllowAction](API_AllowAction.md) 
+  [AllQueryArguments](API_AllQueryArguments.md) 
+  [AndStatement](API_AndStatement.md) 
+  [APIKeySummary](API_APIKeySummary.md) 
+  [ApplicationAttribute](API_ApplicationAttribute.md) 
+  [ApplicationConfig](API_ApplicationConfig.md) 
+  [AsnMatchStatement](API_AsnMatchStatement.md) 
+  [AssociationConfig](API_AssociationConfig.md) 
+  [AWSManagedRulesACFPRuleSet](API_AWSManagedRulesACFPRuleSet.md) 
+  [AWSManagedRulesAntiDDoSRuleSet](API_AWSManagedRulesAntiDDoSRuleSet.md) 
+  [AWSManagedRulesATPRuleSet](API_AWSManagedRulesATPRuleSet.md) 
+  [AWSManagedRulesBotControlRuleSet](API_AWSManagedRulesBotControlRuleSet.md) 
+  [BlockAction](API_BlockAction.md) 
+  [Body](API_Body.md) 
+  [BotStatistics](API_BotStatistics.md) 
+  [ByteMatchStatement](API_ByteMatchStatement.md) 
+  [CaptchaAction](API_CaptchaAction.md) 
+  [CaptchaConfig](API_CaptchaConfig.md) 
+  [CaptchaResponse](API_CaptchaResponse.md) 
+  [ChallengeAction](API_ChallengeAction.md) 
+  [ChallengeConfig](API_ChallengeConfig.md) 
+  [ChallengeResponse](API_ChallengeResponse.md) 
+  [ClientSideAction](API_ClientSideAction.md) 
+  [ClientSideActionConfig](API_ClientSideActionConfig.md) 
+  [Condition](API_Condition.md) 
+  [CookieMatchPattern](API_CookieMatchPattern.md) 
+  [Cookies](API_Cookies.md) 
+  [CountAction](API_CountAction.md) 
+  [CustomHTTPHeader](API_CustomHTTPHeader.md) 
+  [CustomRequestHandling](API_CustomRequestHandling.md) 
+  [CustomResponse](API_CustomResponse.md) 
+  [CustomResponseBody](API_CustomResponseBody.md) 
+  [DataProtection](API_DataProtection.md) 
+  [DataProtectionConfig](API_DataProtectionConfig.md) 
+  [DefaultAction](API_DefaultAction.md) 
+  [DisallowedFeature](API_DisallowedFeature.md) 
+  [EmailField](API_EmailField.md) 
+  [ExcludedRule](API_ExcludedRule.md) 
+  [FieldToMatch](API_FieldToMatch.md) 
+  [FieldToProtect](API_FieldToProtect.md) 
+  [Filter](API_Filter.md) 
+  [FilterSource](API_FilterSource.md) 
+  [FirewallManagerRuleGroup](API_FirewallManagerRuleGroup.md) 
+  [FirewallManagerStatement](API_FirewallManagerStatement.md) 
+  [ForwardedIPConfig](API_ForwardedIPConfig.md) 
+  [GeoMatchStatement](API_GeoMatchStatement.md) 
+  [HeaderMatchPattern](API_HeaderMatchPattern.md) 
+  [HeaderOrder](API_HeaderOrder.md) 
+  [Headers](API_Headers.md) 
+  [HTTPHeader](API_HTTPHeader.md) 
+  [HTTPRequest](API_HTTPRequest.md) 
+  [ImmunityTimeProperty](API_ImmunityTimeProperty.md) 
+  [IPSet](API_IPSet.md) 
+  [IPSetForwardedIPConfig](API_IPSetForwardedIPConfig.md) 
+  [IPSetReferenceStatement](API_IPSetReferenceStatement.md) 
+  [IPSetSummary](API_IPSetSummary.md) 
+  [JA3Fingerprint](API_JA3Fingerprint.md) 
+  [JA4Fingerprint](API_JA4Fingerprint.md) 
+  [JsonBody](API_JsonBody.md) 
+  [JsonMatchPattern](API_JsonMatchPattern.md) 
+  [Label](API_Label.md) 
+  [LabelMatchStatement](API_LabelMatchStatement.md) 
+  [LabelNameCondition](API_LabelNameCondition.md) 
+  [LabelSummary](API_LabelSummary.md) 
+  [LoggingConfiguration](API_LoggingConfiguration.md) 
+  [LoggingFilter](API_LoggingFilter.md) 
+  [ManagedProductDescriptor](API_ManagedProductDescriptor.md) 
+  [ManagedRuleGroupConfig](API_ManagedRuleGroupConfig.md) 
+  [ManagedRuleGroupStatement](API_ManagedRuleGroupStatement.md) 
+  [ManagedRuleGroupSummary](API_ManagedRuleGroupSummary.md) 
+  [ManagedRuleGroupVersion](API_ManagedRuleGroupVersion.md) 
+  [ManagedRuleSet](API_ManagedRuleSet.md) 
+  [ManagedRuleSetSummary](API_ManagedRuleSetSummary.md) 
+  [ManagedRuleSetVersion](API_ManagedRuleSetVersion.md) 
+  [Method](API_Method.md) 
+  [MobileSdkRelease](API_MobileSdkRelease.md) 
+  [NoneAction](API_NoneAction.md) 
+  [NotStatement](API_NotStatement.md) 
+  [OnSourceDDoSProtectionConfig](API_OnSourceDDoSProtectionConfig.md) 
+  [OrStatement](API_OrStatement.md) 
+  [OverrideAction](API_OverrideAction.md) 
+  [PasswordField](API_PasswordField.md) 
+  [PathStatistics](API_PathStatistics.md) 
+  [PhoneNumberField](API_PhoneNumberField.md) 
+  [QueryString](API_QueryString.md) 
+  [RateBasedStatement](API_RateBasedStatement.md) 
+  [RateBasedStatementCustomKey](API_RateBasedStatementCustomKey.md) 
+  [RateBasedStatementManagedKeysIPSet](API_RateBasedStatementManagedKeysIPSet.md) 
+  [RateLimitAsn](API_RateLimitAsn.md) 
+  [RateLimitCookie](API_RateLimitCookie.md) 
+  [RateLimitForwardedIP](API_RateLimitForwardedIP.md) 
+  [RateLimitHeader](API_RateLimitHeader.md) 
+  [RateLimitHTTPMethod](API_RateLimitHTTPMethod.md) 
+  [RateLimitIP](API_RateLimitIP.md) 
+  [RateLimitJA3Fingerprint](API_RateLimitJA3Fingerprint.md) 
+  [RateLimitJA4Fingerprint](API_RateLimitJA4Fingerprint.md) 
+  [RateLimitLabelNamespace](API_RateLimitLabelNamespace.md) 
+  [RateLimitQueryArgument](API_RateLimitQueryArgument.md) 
+  [RateLimitQueryString](API_RateLimitQueryString.md) 
+  [RateLimitUriPath](API_RateLimitUriPath.md) 
+  [Regex](API_Regex.md) 
+  [RegexMatchStatement](API_RegexMatchStatement.md) 
+  [RegexPatternSet](API_RegexPatternSet.md) 
+  [RegexPatternSetReferenceStatement](API_RegexPatternSetReferenceStatement.md) 
+  [RegexPatternSetSummary](API_RegexPatternSetSummary.md) 
+  [ReleaseSummary](API_ReleaseSummary.md) 
+  [RequestBodyAssociatedResourceTypeConfig](API_RequestBodyAssociatedResourceTypeConfig.md) 
+  [RequestInspection](API_RequestInspection.md) 
+  [RequestInspectionACFP](API_RequestInspectionACFP.md) 
+  [ResponseInspection](API_ResponseInspection.md) 
+  [ResponseInspectionBodyContains](API_ResponseInspectionBodyContains.md) 
+  [ResponseInspectionHeader](API_ResponseInspectionHeader.md) 
+  [ResponseInspectionJson](API_ResponseInspectionJson.md) 
+  [ResponseInspectionStatusCode](API_ResponseInspectionStatusCode.md) 
+  [Rule](API_Rule.md) 
+  [RuleAction](API_RuleAction.md) 
+  [RuleActionOverride](API_RuleActionOverride.md) 
+  [RuleGroup](API_RuleGroup.md) 
+  [RuleGroupReferenceStatement](API_RuleGroupReferenceStatement.md) 
+  [RuleGroupSummary](API_RuleGroupSummary.md) 
+  [RuleSummary](API_RuleSummary.md) 
+  [SampledHTTPRequest](API_SampledHTTPRequest.md) 
+  [SingleHeader](API_SingleHeader.md) 
+  [SingleQueryArgument](API_SingleQueryArgument.md) 
+  [SizeConstraintStatement](API_SizeConstraintStatement.md) 
+  [SqliMatchStatement](API_SqliMatchStatement.md) 
+  [Statement](API_Statement.md) 
+  [Tag](API_Tag.md) 
+  [TagInfoForResource](API_TagInfoForResource.md) 
+  [TextTransformation](API_TextTransformation.md) 
+  [TimeWindow](API_TimeWindow.md) 
+  [UriFragment](API_UriFragment.md) 
+  [UriPath](API_UriPath.md) 
+  [UsernameField](API_UsernameField.md) 
+  [VersionToPublish](API_VersionToPublish.md) 
+  [VisibilityConfig](API_VisibilityConfig.md) 
+  [WebACL](API_WebACL.md) 
+  [WebACLSummary](API_WebACLSummary.md) 
+  [XssMatchStatement](API_XssMatchStatement.md) 

# ActionCondition
<a name="API_ActionCondition"></a>

A single action condition for a [Condition](API_Condition.md) in a logging filter.

## Contents
<a name="API_ActionCondition_Contents"></a>

 ** Action **   <a name="WAF-Type-ActionCondition-Action"></a>
The action setting that a log record must contain in order to meet the condition. This is the action that AWS 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.   
Type: String  
Valid Values: `ALLOW | BLOCK | COUNT | CAPTCHA | CHALLENGE | EXCLUDED_AS_COUNT`   
Required: Yes

## See Also
<a name="API_ActionCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ActionCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ActionCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ActionCondition) 

# AddressField
<a name="API_AddressField"></a>

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. 

## Contents
<a name="API_AddressField_Contents"></a>

 ** Identifier **   <a name="WAF-Type-AddressField-Identifier"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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`, and `primaryaddressline3`, the address fields identifiers are `primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_AddressField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AddressField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AddressField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AddressField) 

# All
<a name="API_All"></a>

Inspect all of the elements that AWS WAF has parsed and extracted from the web request component that you've identified in your [FieldToMatch](API_FieldToMatch.md) specifications. 

This is used in the [FieldToMatch](API_FieldToMatch.md) specification for some web request component types. 

JSON specification: `"All": {}` 

## Contents
<a name="API_All_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_All_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/All) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/All) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/All) 

# AllowAction
<a name="API_AllowAction"></a>

Specifies that AWS 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](API_RuleAction.md) and web ACL [DefaultAction](API_DefaultAction.md). 

## Contents
<a name="API_AllowAction_Contents"></a>

 ** CustomRequestHandling **   <a name="WAF-Type-AllowAction-CustomRequestHandling"></a>
Defines custom handling for the web request.  
For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
Type: [CustomRequestHandling](API_CustomRequestHandling.md) object  
Required: No

## See Also
<a name="API_AllowAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AllowAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AllowAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AllowAction) 

# AllQueryArguments
<a name="API_AllQueryArguments"></a>

Inspect all query arguments of the web request. 

This is used in the [FieldToMatch](API_FieldToMatch.md) specification for some web request component types. 

JSON specification: `"AllQueryArguments": {}` 

## Contents
<a name="API_AllQueryArguments_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_AllQueryArguments_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AllQueryArguments) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AllQueryArguments) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AllQueryArguments) 

# AndStatement
<a name="API_AndStatement"></a>

A logical rule statement used to combine other rule statements with AND logic. You provide more than one [Statement](API_Statement.md) within the `AndStatement`. 

## Contents
<a name="API_AndStatement_Contents"></a>

 ** Statements **   <a name="WAF-Type-AndStatement-Statements"></a>
The statements to combine with AND logic. You can use any statements that can be nested.   
Type: Array of [Statement](API_Statement.md) objects  
Required: Yes

## See Also
<a name="API_AndStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AndStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AndStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AndStatement) 

# APIKeySummary
<a name="API_APIKeySummary"></a>

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 [AWS WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the * AWS WAF Developer Guide*.

## Contents
<a name="API_APIKeySummary_Contents"></a>

 ** APIKey **   <a name="WAF-Type-APIKeySummary-APIKey"></a>
The generated, encrypted API key. You can copy this for use in your JavaScript CAPTCHA integration.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** CreationTimestamp **   <a name="WAF-Type-APIKeySummary-CreationTimestamp"></a>
The date and time that the key was created.   
Type: Timestamp  
Required: No

 ** TokenDomains **   <a name="WAF-Type-APIKeySummary-TokenDomains"></a>
The token domains that are defined in this API key.   
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^[\w\.\-/]+$`   
Required: No

 ** Version **   <a name="WAF-Type-APIKeySummary-Version"></a>
Internal value used by AWS WAF to manage the key.   
Type: Integer  
Valid Range: Minimum value of 0.  
Required: No

## See Also
<a name="API_APIKeySummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/APIKeySummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/APIKeySummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/APIKeySummary) 

# ApplicationAttribute
<a name="API_ApplicationAttribute"></a>

Application details defined during the web ACL creation process. Application attributes help AWS WAF give recommendations for protection packs.

## Contents
<a name="API_ApplicationAttribute_Contents"></a>

 ** Name **   <a name="WAF-Type-ApplicationAttribute-Name"></a>
Specifies the attribute name.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w\-]+$`   
Required: No

 ** Values **   <a name="WAF-Type-ApplicationAttribute-Values"></a>
Specifies the attribute value.  
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 50 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Required: No

## See Also
<a name="API_ApplicationAttribute_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ApplicationAttribute) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ApplicationAttribute) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ApplicationAttribute) 

# ApplicationConfig
<a name="API_ApplicationConfig"></a>

A list of `ApplicationAttribute`s that contains information about the application.

## Contents
<a name="API_ApplicationConfig_Contents"></a>

 ** Attributes **   <a name="WAF-Type-ApplicationConfig-Attributes"></a>
Contains the attribute name and a list of values for that attribute.  
Type: Array of [ApplicationAttribute](API_ApplicationAttribute.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Required: No

## See Also
<a name="API_ApplicationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ApplicationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ApplicationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ApplicationConfig) 

# AsnMatchStatement
<a name="API_AsnMatchStatement"></a>

A rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.

For additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). 

## Contents
<a name="API_AsnMatchStatement_Contents"></a>

 ** AsnList **   <a name="WAF-Type-AsnMatchStatement-AsnList"></a>
Contains one or more Autonomous System Numbers (ASNs). ASNs are unique identifiers assigned to large internet networks managed by organizations such as internet service providers, enterprises, universities, or government agencies.   
Type: Array of longs  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Valid Range: Minimum value of 0. Maximum value of 4294967295.  
Required: Yes

 ** ForwardedIPConfig **   <a name="WAF-Type-AsnMatchStatement-ForwardedIPConfig"></a>
The configuration for inspecting IP addresses to match against an ASN 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.   
Type: [ForwardedIPConfig](API_ForwardedIPConfig.md) object  
Required: No

## See Also
<a name="API_AsnMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AsnMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AsnMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AsnMatchStatement) 

# AssociationConfig
<a name="API_AssociationConfig"></a>

Specifies custom configurations for the associations between the web ACL and protected resources. 

Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes). 

**Note**  
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).

For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).

## Contents
<a name="API_AssociationConfig_Contents"></a>

 ** RequestBody **   <a name="WAF-Type-AssociationConfig-RequestBody"></a>
Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS 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 [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).
Example JSON: ` { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }`   
For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).  
Type: String to [RequestBodyAssociatedResourceTypeConfig](API_RequestBodyAssociatedResourceTypeConfig.md) object map  
Valid Keys: `CLOUDFRONT | API_GATEWAY | COGNITO_USER_POOL | APP_RUNNER_SERVICE | VERIFIED_ACCESS_INSTANCE`   
Required: No

## See Also
<a name="API_AssociationConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AssociationConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AssociationConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AssociationConfig) 

# AWSManagedRulesACFPRuleSet
<a name="API_AWSManagedRulesACFPRuleSet"></a>

Details for your use of the account creation fraud prevention managed rule group, `AWSManagedRulesACFPRuleSet`. This configuration is used in `ManagedRuleGroupConfig`. 

For additional information about this and the other intelligent threat mitigation rule groups, see [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections) and [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_AWSManagedRulesACFPRuleSet_Contents"></a>

 ** CreationPath **   <a name="WAF-Type-AWSManagedRulesACFPRuleSet-CreationPath"></a>
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`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** RegistrationPagePath **   <a name="WAF-Type-AWSManagedRulesACFPRuleSet-RegistrationPagePath"></a>
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`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** RequestInspection **   <a name="WAF-Type-AWSManagedRulesACFPRuleSet-RequestInspection"></a>
The criteria for inspecting account creation requests, used by the ACFP rule group to validate and track account creation attempts.   
Type: [RequestInspectionACFP](API_RequestInspectionACFP.md) object  
Required: Yes

 ** EnableRegexInPath **   <a name="WAF-Type-AWSManagedRulesACFPRuleSet-EnableRegexInPath"></a>
Allow the use of regular expressions in the registration page path and the account creation path.   
Type: Boolean  
Required: No

 ** ResponseInspection **   <a name="WAF-Type-AWSManagedRulesACFPRuleSet-ResponseInspection"></a>
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.   
Type: [ResponseInspection](API_ResponseInspection.md) object  
Required: No

## See Also
<a name="API_AWSManagedRulesACFPRuleSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AWSManagedRulesACFPRuleSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AWSManagedRulesACFPRuleSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AWSManagedRulesACFPRuleSet) 

# AWSManagedRulesAntiDDoSRuleSet
<a name="API_AWSManagedRulesAntiDDoSRuleSet"></a>

Configures the use of the anti-DDoS managed rule group, `AWSManagedRulesAntiDDoSRuleSet`. This configuration is used in `ManagedRuleGroupConfig`. 

The configuration that you provide here determines whether and how the rules in the rule group are used. 

For additional information about this and the other intelligent threat mitigation rule groups, see [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections) and [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_AWSManagedRulesAntiDDoSRuleSet_Contents"></a>

 ** ClientSideActionConfig **   <a name="WAF-Type-AWSManagedRulesAntiDDoSRuleSet-ClientSideActionConfig"></a>
Configures the request handling that's applied by the managed rule group rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` during a distributed denial of service (DDoS) attack.  
Type: [ClientSideActionConfig](API_ClientSideActionConfig.md) object  
Required: Yes

 ** SensitivityToBlock **   <a name="WAF-Type-AWSManagedRulesAntiDDoSRuleSet-SensitivityToBlock"></a>
The sensitivity that the rule group rule `DDoSRequests` uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the `DDoSRequests` rule runs.   
The higher the sensitivity, the more levels of labeling that the rule matches:   
+ Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label `awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request`.
+ Medium sensitivity causes the rule to match on the medium and high suspicion labels.
+ High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.
Default: `LOW`   
Type: String  
Valid Values: `LOW | MEDIUM | HIGH`   
Required: No

## See Also
<a name="API_AWSManagedRulesAntiDDoSRuleSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AWSManagedRulesAntiDDoSRuleSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AWSManagedRulesAntiDDoSRuleSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AWSManagedRulesAntiDDoSRuleSet) 

# AWSManagedRulesATPRuleSet
<a name="API_AWSManagedRulesATPRuleSet"></a>

Details for your use of the account takeover prevention managed rule group, `AWSManagedRulesATPRuleSet`. This configuration is used in `ManagedRuleGroupConfig`. 

For additional information about this and the other intelligent threat mitigation rule groups, see [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections) and [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_AWSManagedRulesATPRuleSet_Contents"></a>

 ** LoginPath **   <a name="WAF-Type-AWSManagedRulesATPRuleSet-LoginPath"></a>
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.  
Type: String  
Required: Yes

 ** EnableRegexInPath **   <a name="WAF-Type-AWSManagedRulesATPRuleSet-EnableRegexInPath"></a>
Allow the use of regular expressions in the login page path.   
Type: Boolean  
Required: No

 ** RequestInspection **   <a name="WAF-Type-AWSManagedRulesATPRuleSet-RequestInspection"></a>
The criteria for inspecting login requests, used by the ATP rule group to validate credentials usage.   
Type: [RequestInspection](API_RequestInspection.md) object  
Required: No

 ** ResponseInspection **   <a name="WAF-Type-AWSManagedRulesATPRuleSet-ResponseInspection"></a>
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.   
Type: [ResponseInspection](API_ResponseInspection.md) object  
Required: No

## See Also
<a name="API_AWSManagedRulesATPRuleSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AWSManagedRulesATPRuleSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AWSManagedRulesATPRuleSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AWSManagedRulesATPRuleSet) 

# AWSManagedRulesBotControlRuleSet
<a name="API_AWSManagedRulesBotControlRuleSet"></a>

Details for your use of the Bot Control managed rule group, `AWSManagedRulesBotControlRuleSet`. This configuration is used in `ManagedRuleGroupConfig`. 

For additional information about this and the other intelligent threat mitigation rule groups, see [Intelligent threat mitigation in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-managed-protections) and [AWS Managed Rules rule groups list](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-list) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_AWSManagedRulesBotControlRuleSet_Contents"></a>

 ** InspectionLevel **   <a name="WAF-Type-AWSManagedRulesBotControlRuleSet-InspectionLevel"></a>
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 [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) in the * AWS WAF Developer Guide*.  
Type: String  
Valid Values: `COMMON | TARGETED`   
Required: Yes

 ** EnableMachineLearning **   <a name="WAF-Type-AWSManagedRulesBotControlRuleSet-EnableMachineLearning"></a>
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` and `TGT_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](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html#aws-managed-rule-groups-bot-rules) in the * AWS WAF Developer Guide*.  
Default: `TRUE`   
Type: Boolean  
Required: No

## See Also
<a name="API_AWSManagedRulesBotControlRuleSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/AWSManagedRulesBotControlRuleSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/AWSManagedRulesBotControlRuleSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/AWSManagedRulesBotControlRuleSet) 

# BlockAction
<a name="API_BlockAction"></a>

Specifies that AWS 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](API_RuleAction.md) and web ACL [DefaultAction](API_DefaultAction.md). 

## Contents
<a name="API_BlockAction_Contents"></a>

 ** CustomResponse **   <a name="WAF-Type-BlockAction-CustomResponse"></a>
Defines a custom response for the web request.  
For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
Type: [CustomResponse](API_CustomResponse.md) object  
Required: No

## See Also
<a name="API_BlockAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/BlockAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/BlockAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/BlockAction) 

# Body
<a name="API_Body"></a>

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](API_FieldToMatch.md) specification. 

## Contents
<a name="API_Body_Contents"></a>

 ** OversizeHandling **   <a name="WAF-Type-Body-OversizeHandling"></a>
What AWS WAF should do if the body is larger than AWS WAF can inspect.   
 AWS 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 AWS WAF for inspection.   
+ For Application Load Balancer and AWS 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 AWS Amplify, use the CloudFront limit.
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. AWS 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` or `NO_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`   
Type: String  
Valid Values: `CONTINUE | MATCH | NO_MATCH`   
Required: No

## See Also
<a name="API_Body_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Body) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Body) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Body) 

# BotStatistics
<a name="API_BotStatistics"></a>

Statistics about a specific bot's traffic to a path, including the bot name, request count, and percentage of traffic.

## Contents
<a name="API_BotStatistics_Contents"></a>

 ** BotName **   <a name="WAF-Type-BotStatistics-BotName"></a>
The name of the bot. For example, `gptbot` or `googlebot`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: Yes

 ** Percentage **   <a name="WAF-Type-BotStatistics-Percentage"></a>
The percentage of total requests to the associated path that came from this bot.  
Type: Double  
Valid Range: Minimum value of 0.0. Maximum value of 100.0.  
Required: Yes

 ** RequestCount **   <a name="WAF-Type-BotStatistics-RequestCount"></a>
The number of requests from this bot to the associated path within the specified time window.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: Yes

## See Also
<a name="API_BotStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/BotStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/BotStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/BotStatistics) 

# ByteMatchStatement
<a name="API_ByteMatchStatement"></a>

A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.

## Contents
<a name="API_ByteMatchStatement_Contents"></a>

 ** FieldToMatch **   <a name="WAF-Type-ByteMatchStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** PositionalConstraint **   <a name="WAF-Type-ByteMatchStatement-PositionalConstraint"></a>
The area within the portion of the web request that you want AWS 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\$1WORD**   
The specified part of the web request must include the value of `SearchString`, and `SearchString` must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or \$1). 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 (\$1). 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 (\$1), for example, `BadBot;` and `-BadBot;`.
 **EXACTLY**   
The value of the specified part of the web request must exactly match the value of `SearchString`.  
 **STARTS\$1WITH**   
The value of `SearchString` must appear at the beginning of the specified part of the web request.  
 **ENDS\$1WITH**   
The value of `SearchString` must appear at the end of the specified part of the web request.  
Type: String  
Valid Values: `EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD`   
Required: Yes

 ** SearchString **   <a name="WAF-Type-ByteMatchStatement-SearchString"></a>
A string value that you want AWS WAF to search for. AWS WAF searches only in the part of web requests that you designate for inspection in [FieldToMatch](API_FieldToMatch.md). 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 AWS WAF to search for. This indicates the type of operation specified in the request. 
+  `UriPath`: The value that you want AWS 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 match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY`. 

  You can obtain the JA3 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS WAF Developer Guide*. 
+  `HeaderOrder`: The list of header names to match for. AWS 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 AWS 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` is `HEADER` and the value of `Data` is `User-Agent`. If you want to search the `User-Agent` header for the value `BadBot`, you base64-encode `BadBot` using MIME base64-encoding and include the resulting value, `QmFkQm90`, in the value of `SearchString`.  
 **If you're using the AWS CLI or one of the AWS SDKs**   
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.  
Type: Base64-encoded binary data object  
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-ByteMatchStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_ByteMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ByteMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ByteMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ByteMatchStatement) 

# CaptchaAction
<a name="API_CaptchaAction"></a>

Specifies that AWS WAF should run a `CAPTCHA` check against the request: 
+ If the request includes a valid, unexpired `CAPTCHA` token, AWS 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 token, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

   AWS WAF generates a response that it sends back to the client, which includes the following: 
  + The header `x-amzn-waf-action` with a value of `captcha`. 
  + The HTTP status code `405 Method Not Allowed`. 
  + If the request contains an `Accept` header with a value of `text/html`, the response includes a `CAPTCHA` 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. 

## Contents
<a name="API_CaptchaAction_Contents"></a>

 ** CustomRequestHandling **   <a name="WAF-Type-CaptchaAction-CustomRequestHandling"></a>
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 AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
Type: [CustomRequestHandling](API_CustomRequestHandling.md) object  
Required: No

## See Also
<a name="API_CaptchaAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CaptchaAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CaptchaAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CaptchaAction) 

# CaptchaConfig
<a name="API_CaptchaConfig"></a>

Specifies how AWS WAF should handle `CAPTCHA` evaluations. This is available at the web ACL level and in each rule. 

## Contents
<a name="API_CaptchaConfig_Contents"></a>

 ** ImmunityTimeProperty **   <a name="WAF-Type-CaptchaConfig-ImmunityTimeProperty"></a>
Determines how long a `CAPTCHA` timestamp in the token remains valid after the client successfully solves a `CAPTCHA` puzzle.   
Type: [ImmunityTimeProperty](API_ImmunityTimeProperty.md) object  
Required: No

## See Also
<a name="API_CaptchaConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CaptchaConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CaptchaConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CaptchaConfig) 

# CaptchaResponse
<a name="API_CaptchaResponse"></a>

The result from the inspection of the web request for a valid `CAPTCHA` token. 

## Contents
<a name="API_CaptchaResponse_Contents"></a>

 ** FailureReason **   <a name="WAF-Type-CaptchaResponse-FailureReason"></a>
The reason for failure, populated when the evaluation of the token fails.  
Type: String  
Valid Values: `TOKEN_MISSING | TOKEN_EXPIRED | TOKEN_INVALID | TOKEN_DOMAIN_MISMATCH`   
Required: No

 ** ResponseCode **   <a name="WAF-Type-CaptchaResponse-ResponseCode"></a>
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 is `405 Method Not Allowed`.  
Type: Integer  
Required: No

 ** SolveTimestamp **   <a name="WAF-Type-CaptchaResponse-SolveTimestamp"></a>
The time that the `CAPTCHA` was last solved for the supplied token.   
Type: Long  
Required: No

## See Also
<a name="API_CaptchaResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CaptchaResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CaptchaResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CaptchaResponse) 

# ChallengeAction
<a name="API_ChallengeAction"></a>

Specifies that AWS 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, AWS 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, AWS WAF discontinues the web ACL evaluation of the request and blocks it from going to its intended destination.

   AWS 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 of `challenge`. 
  + The HTTP status code `202 Request Accepted`. 
  + If the request contains an `Accept` header with a value of `text/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 AWS 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. 

## Contents
<a name="API_ChallengeAction_Contents"></a>

 ** CustomRequestHandling **   <a name="WAF-Type-ChallengeAction-CustomRequestHandling"></a>
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 AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
Type: [CustomRequestHandling](API_CustomRequestHandling.md) object  
Required: No

## See Also
<a name="API_ChallengeAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ChallengeAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ChallengeAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ChallengeAction) 

# ChallengeConfig
<a name="API_ChallengeConfig"></a>

Specifies how AWS WAF should handle `Challenge` evaluations. This is available at the web ACL level and in each rule. 

## Contents
<a name="API_ChallengeConfig_Contents"></a>

 ** ImmunityTimeProperty **   <a name="WAF-Type-ChallengeConfig-ImmunityTimeProperty"></a>
Determines how long a challenge timestamp in the token remains valid after the client successfully responds to a challenge.   
Type: [ImmunityTimeProperty](API_ImmunityTimeProperty.md) object  
Required: No

## See Also
<a name="API_ChallengeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ChallengeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ChallengeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ChallengeConfig) 

# ChallengeResponse
<a name="API_ChallengeResponse"></a>

The result from the inspection of the web request for a valid challenge token. 

## Contents
<a name="API_ChallengeResponse_Contents"></a>

 ** FailureReason **   <a name="WAF-Type-ChallengeResponse-FailureReason"></a>
The reason for failure, populated when the evaluation of the token fails.  
Type: String  
Valid Values: `TOKEN_MISSING | TOKEN_EXPIRED | TOKEN_INVALID | TOKEN_DOMAIN_MISMATCH`   
Required: No

 ** ResponseCode **   <a name="WAF-Type-ChallengeResponse-ResponseCode"></a>
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`.  
Type: Integer  
Required: No

 ** SolveTimestamp **   <a name="WAF-Type-ChallengeResponse-SolveTimestamp"></a>
The time that the challenge was last solved for the supplied token.   
Type: Long  
Required: No

## See Also
<a name="API_ChallengeResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ChallengeResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ChallengeResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ChallengeResponse) 

# ClientSideAction
<a name="API_ClientSideAction"></a>

This is part of the `AWSManagedRulesAntiDDoSRuleSet` `ClientSideActionConfig` configuration in `ManagedRuleGroupConfig`.

## Contents
<a name="API_ClientSideAction_Contents"></a>

 ** UsageOfAction **   <a name="WAF-Type-ClientSideAction-UsageOfAction"></a>
Determines whether to use the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the rule group evaluation and the related label `awswaf:managed:aws:anti-ddos:challengeable-request`.   
+ If usage is enabled: 
  + The managed rule group adds the label `awswaf:managed:aws:anti-ddos:challengeable-request` to any web request whose URL does *NOT* match the regular expressions provided in the `ClientSideAction` setting `ExemptUriRegularExpressions`. 
  + The two rules are evaluated against web requests for protected resources that are experiencing a DDoS attack. The two rules only apply their action to matching requests that have the label `awswaf:managed:aws:anti-ddos:challengeable-request`. 
+ If usage is disabled: 
  + The managed rule group doesn't add the label `awswaf:managed:aws:anti-ddos:challengeable-request` to any web requests. 
  + The two rules are not evaluated.
  + None of the other `ClientSideAction` settings have any effect.
This setting only enables or disables the use of the two anti-DDOS rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests` in the anti-DDoS managed rule group.   
This setting doesn't alter the action setting in the two rules. To override the actions used by the rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`, enable this setting, and then override the rule actions in the usual way, in your managed rule group configuration. 
Type: String  
Valid Values: `ENABLED | DISABLED`   
Required: Yes

 ** ExemptUriRegularExpressions **   <a name="WAF-Type-ClientSideAction-ExemptUriRegularExpressions"></a>
The regular expression to match against the web request URI, used to identify requests that can't handle a silent browser challenge. When the `ClientSideAction` setting `UsageOfAction` is enabled, the managed rule group uses this setting to determine which requests to label with `awswaf:managed:aws:anti-ddos:challengeable-request`. If `UsageOfAction` is disabled, this setting has no effect and the managed rule group doesn't add the label to any requests.  
The anti-DDoS managed rule group doesn't evaluate the rules `ChallengeDDoSRequests` or `ChallengeAllDuringEvent` for web requests whose URIs match this regex. This is true regardless of whether you override the rule action for either of the rules in your web ACL configuration.   
 AWS recommends using a regular expression.   
This setting is required if `UsageOfAction` is set to `ENABLED`. If required, you can provide between 1 and 5 regex objects in the array of settings.   
 AWS recommends starting with the following setting. Review and update it for your application's needs:  
 `\/api\/|\.(acc|avi|css|gif|jpe?g|js|mp[34]|ogg|otf|pdf|png|tiff?|ttf|webm|webp|woff2?)$`   
Type: Array of [Regex](API_Regex.md) objects  
Required: No

 ** Sensitivity **   <a name="WAF-Type-ClientSideAction-Sensitivity"></a>
The sensitivity that the rule group rule `ChallengeDDoSRequests` uses when matching against the DDoS suspicion labeling on a request. The managed rule group adds the labeling during DDoS events, before the `ChallengeDDoSRequests` rule runs.   
The higher the sensitivity, the more levels of labeling that the rule matches:   
+ Low sensitivity is less sensitive, causing the rule to match only on the most likely participants in an attack, which are the requests with the high suspicion label `awswaf:managed:aws:anti-ddos:high-suspicion-ddos-request`.
+ Medium sensitivity causes the rule to match on the medium and high suspicion labels.
+ High sensitivity causes the rule to match on all of the suspicion labels: low, medium, and high.
Default: `HIGH`   
Type: String  
Valid Values: `LOW | MEDIUM | HIGH`   
Required: No

## See Also
<a name="API_ClientSideAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ClientSideAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ClientSideAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ClientSideAction) 

# ClientSideActionConfig
<a name="API_ClientSideActionConfig"></a>

This is part of the configuration for the managed rules `AWSManagedRulesAntiDDoSRuleSet` in `ManagedRuleGroupConfig`.

## Contents
<a name="API_ClientSideActionConfig_Contents"></a>

 ** Challenge **   <a name="WAF-Type-ClientSideActionConfig-Challenge"></a>
Configuration for the use of the `AWSManagedRulesAntiDDoSRuleSet` rules `ChallengeAllDuringEvent` and `ChallengeDDoSRequests`.   
This setting isn't related to the configuration of the `Challenge` action itself. It only configures the use of the two anti-DDoS rules named here. 
You can enable or disable the use of these rules, and you can configure how to use them when they are enabled.   
Type: [ClientSideAction](API_ClientSideAction.md) object  
Required: Yes

## See Also
<a name="API_ClientSideActionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ClientSideActionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ClientSideActionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ClientSideActionConfig) 

# Condition
<a name="API_Condition"></a>

A single match condition for a [Filter](API_Filter.md).

## Contents
<a name="API_Condition_Contents"></a>

 ** ActionCondition **   <a name="WAF-Type-Condition-ActionCondition"></a>
A single action condition. This is the action setting that a log record must contain in order to meet the condition.  
Type: [ActionCondition](API_ActionCondition.md) object  
Required: No

 ** LabelNameCondition **   <a name="WAF-Type-Condition-LabelNameCondition"></a>
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.   
Type: [LabelNameCondition](API_LabelNameCondition.md) object  
Required: No

## See Also
<a name="API_Condition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Condition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Condition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Condition) 

# CookieMatchPattern
<a name="API_CookieMatchPattern"></a>

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" ] }` 

## Contents
<a name="API_CookieMatchPattern_Contents"></a>

 ** All **   <a name="WAF-Type-CookieMatchPattern-All"></a>
Inspect all cookies.   
Type: [All](API_All.md) object  
Required: No

 ** ExcludedCookies **   <a name="WAF-Type-CookieMatchPattern-ExcludedCookies"></a>
Inspect only the cookies whose keys don't match any of the strings specified here.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 199 items.  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `.*\S.*`   
Required: No

 ** IncludedCookies **   <a name="WAF-Type-CookieMatchPattern-IncludedCookies"></a>
Inspect only the cookies that have a key that matches one of the strings specified here.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 199 items.  
Length Constraints: Minimum length of 1. Maximum length of 60.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_CookieMatchPattern_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CookieMatchPattern) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CookieMatchPattern) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CookieMatchPattern) 

# Cookies
<a name="API_Cookies"></a>

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](API_FieldToMatch.md) specification. 

Example JSON: `"Cookies": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }` 

## Contents
<a name="API_Cookies_Contents"></a>

 ** MatchPattern **   <a name="WAF-Type-Cookies-MatchPattern"></a>
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" ] }`   
Type: [CookieMatchPattern](API_CookieMatchPattern.md) object  
Required: Yes

 ** MatchScope **   <a name="WAF-Type-Cookies-MatchScope"></a>
The parts of the cookies to inspect with the rule inspection criteria. If you specify `ALL`, AWS 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 logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.   
Type: String  
Valid Values: `ALL | KEY | VALUE`   
Required: Yes

 ** OversizeHandling **   <a name="WAF-Type-Cookies-OversizeHandling"></a>
What AWS WAF should do if the cookies of the request are more numerous or larger than AWS WAF can inspect. AWS 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 AWS 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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `CONTINUE | MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_Cookies_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Cookies) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Cookies) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Cookies) 

# CountAction
<a name="API_CountAction"></a>

Specifies that AWS 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](API_RuleAction.md) and web ACL [DefaultAction](API_DefaultAction.md). 

## Contents
<a name="API_CountAction_Contents"></a>

 ** CustomRequestHandling **   <a name="WAF-Type-CountAction-CustomRequestHandling"></a>
Defines custom handling for the web request.  
For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
Type: [CustomRequestHandling](API_CustomRequestHandling.md) object  
Required: No

## See Also
<a name="API_CountAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CountAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CountAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CountAction) 

# CustomHTTPHeader
<a name="API_CustomHTTPHeader"></a>

A custom header for custom request and response handling. This is used in [CustomResponse](API_CustomResponse.md) and [CustomRequestHandling](API_CustomRequestHandling.md).

## Contents
<a name="API_CustomHTTPHeader_Contents"></a>

 ** Name **   <a name="WAF-Type-CustomHTTPHeader-Name"></a>
The name of the custom header.   
For custom request header insertion, when AWS 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 name `sample`, AWS WAF inserts the header `x-amzn-waf-sample`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[a-zA-Z0-9._$-]+$`   
Required: Yes

 ** Value **   <a name="WAF-Type-CustomHTTPHeader-Value"></a>
The value of the custom header.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `.*`   
Required: Yes

## See Also
<a name="API_CustomHTTPHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CustomHTTPHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CustomHTTPHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CustomHTTPHeader) 

# CustomRequestHandling
<a name="API_CustomRequestHandling"></a>

Custom request handling behavior that inserts custom headers into a web request. You can add custom request handling for AWS 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 AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_CustomRequestHandling_Contents"></a>

 ** InsertHeaders **   <a name="WAF-Type-CustomRequestHandling-InsertHeaders"></a>
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 [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the * AWS WAF Developer Guide*.   
Type: Array of [CustomHTTPHeader](API_CustomHTTPHeader.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_CustomRequestHandling_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CustomRequestHandling) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CustomRequestHandling) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CustomRequestHandling) 

# CustomResponse
<a name="API_CustomResponse"></a>

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](API_BlockAction.md). 

For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*. 

## Contents
<a name="API_CustomResponse_Contents"></a>

 ** ResponseCode **   <a name="WAF-Type-CustomResponse-ResponseCode"></a>
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](https://docs.aws.amazon.com/waf/latest/developerguide/customizing-the-response-status-codes.html) in the * AWS WAF Developer Guide*.   
Type: Integer  
Valid Range: Minimum value of 200. Maximum value of 599.  
Required: Yes

 ** CustomResponseBodyKey **   <a name="WAF-Type-CustomResponse-CustomResponseBodyKey"></a>
References the response body that you want AWS 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](API_WebACL.md) or [RuleGroup](API_RuleGroup.md) where you want to use it. Then, in the rule action or web ACL default action `BlockAction` setting, you reference the response body using this key.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** ResponseHeaders **   <a name="WAF-Type-CustomResponse-ResponseHeaders"></a>
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 [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the * AWS WAF Developer Guide*.   
Type: Array of [CustomHTTPHeader](API_CustomHTTPHeader.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also
<a name="API_CustomResponse_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CustomResponse) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CustomResponse) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CustomResponse) 

# CustomResponseBody
<a name="API_CustomResponseBody"></a>

The response body to use in a custom response to a web request. This is referenced by key from [CustomResponse](API_CustomResponse.md) `CustomResponseBodyKey`.

## Contents
<a name="API_CustomResponseBody_Contents"></a>

 ** Content **   <a name="WAF-Type-CustomResponseBody-Content"></a>
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 [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the * AWS WAF Developer Guide*.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 10240.  
Pattern: `[\s\S]*`   
Required: Yes

 ** ContentType **   <a name="WAF-Type-CustomResponseBody-ContentType"></a>
The type of content in the payload that you are defining in the `Content` string.  
Type: String  
Valid Values: `TEXT_PLAIN | TEXT_HTML | APPLICATION_JSON`   
Required: Yes

## See Also
<a name="API_CustomResponseBody_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/CustomResponseBody) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/CustomResponseBody) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/CustomResponseBody) 

# DataProtection
<a name="API_DataProtection"></a>

Specifies the protection behavior for a field type. This is part of the data protection configuration for a web ACL. 

## Contents
<a name="API_DataProtection_Contents"></a>

 ** Action **   <a name="WAF-Type-DataProtection-Action"></a>
Specifies how to protect the field. AWS WAF can apply a one-way hash to the field or hard code a string substitution.   
+ One-way hash example: `ade099751dEXAMPLEHASH2ea9f3393f80dd5d3bEXAMPLEHASH966ae0d3cd5a1e` 
+ Substitution example: `REDACTED` 
Type: String  
Valid Values: `SUBSTITUTION | HASH`   
Required: Yes

 ** Field **   <a name="WAF-Type-DataProtection-Field"></a>
Specifies the field type and optional keys to apply the protection behavior to.   
Type: [FieldToProtect](API_FieldToProtect.md) object  
Required: Yes

 ** ExcludeRateBasedDetails **   <a name="WAF-Type-DataProtection-ExcludeRateBasedDetails"></a>
Specifies whether to also exclude any rate-based rule details from the data protection you have enabled for a given field. If you specify this exception, RateBasedDetails will show the value of the field. For additional information, see the log field `rateBasedRuleList` at [Log fields for web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS WAF Developer Guide*.  
Default: `FALSE`   
Type: Boolean  
Required: No

 ** ExcludeRuleMatchDetails **   <a name="WAF-Type-DataProtection-ExcludeRuleMatchDetails"></a>
Specifies whether to also exclude any rule match details from the data protection you have enabled for a given field. AWS WAF logs these details for non-terminating matching rules and for the terminating matching rule. For additional information, see [Log fields for web ACL traffic](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS WAF Developer Guide*.  
Default: `FALSE`   
Type: Boolean  
Required: No

## See Also
<a name="API_DataProtection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/DataProtection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/DataProtection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/DataProtection) 

# DataProtectionConfig
<a name="API_DataProtectionConfig"></a>

Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option. 

The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging. 

This is part of the data protection configuration for a web ACL. 

## Contents
<a name="API_DataProtectionConfig_Contents"></a>

 ** DataProtections **   <a name="WAF-Type-DataProtectionConfig-DataProtections"></a>
An array of data protection configurations for specific web request field types. This is defined for each web ACL. AWS WAF applies the specified protection to all web requests that the web ACL inspects.   
Type: Array of [DataProtection](API_DataProtection.md) objects  
Array Members: Minimum number of 1 item. Maximum number of 26 items.  
Required: Yes

## See Also
<a name="API_DataProtectionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/DataProtectionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/DataProtectionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/DataProtectionConfig) 

# DefaultAction
<a name="API_DefaultAction"></a>

In a [WebACL](API_WebACL.md), this is the action that you want AWS 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.

## Contents
<a name="API_DefaultAction_Contents"></a>

 ** Allow **   <a name="WAF-Type-DefaultAction-Allow"></a>
Specifies that AWS WAF should allow requests by default.  
Type: [AllowAction](API_AllowAction.md) object  
Required: No

 ** Block **   <a name="WAF-Type-DefaultAction-Block"></a>
Specifies that AWS WAF should block requests by default.   
Type: [BlockAction](API_BlockAction.md) object  
Required: No

## See Also
<a name="API_DefaultAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/DefaultAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/DefaultAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/DefaultAction) 

# DisallowedFeature
<a name="API_DisallowedFeature"></a>

A AWS WAF feature that is not supported by the CloudFront pricing plan associated with the web ACL.

## Contents
<a name="API_DisallowedFeature_Contents"></a>

 ** Feature **   <a name="WAF-Type-DisallowedFeature-Feature"></a>
The name of the disallowed AWS WAF feature.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** RequiredPricingPlan **   <a name="WAF-Type-DisallowedFeature-RequiredPricingPlan"></a>
The name of the CloudFront pricing plan required to use the AWS WAF feature.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_DisallowedFeature_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/DisallowedFeature) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/DisallowedFeature) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/DisallowedFeature) 

# EmailField
<a name="API_EmailField"></a>

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. 

## Contents
<a name="API_EmailField_Contents"></a>

 ** Identifier **   <a name="WAF-Type-EmailField-Identifier"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `email1`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_EmailField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/EmailField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/EmailField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/EmailField) 

# ExcludedRule
<a name="API_ExcludedRule"></a>

Specifies a single rule in a rule group whose action you want to override to `Count`. 

**Note**  
Instead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.

## Contents
<a name="API_ExcludedRule_Contents"></a>

 ** Name **   <a name="WAF-Type-ExcludedRule-Name"></a>
The name of the rule whose action you want to override to `Count`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

## See Also
<a name="API_ExcludedRule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ExcludedRule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ExcludedRule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ExcludedRule) 

# FieldToMatch
<a name="API_FieldToMatch"></a>

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 AWS 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 in `FieldToMatch` 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 are `UriPath`, `QueryString`, `SingleHeader`, and `Method`.
  + 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. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.

## Contents
<a name="API_FieldToMatch_Contents"></a>

 ** AllQueryArguments **   <a name="WAF-Type-FieldToMatch-AllQueryArguments"></a>
Inspect all query arguments.   
Type: [AllQueryArguments](API_AllQueryArguments.md) object  
Required: No

 ** Body **   <a name="WAF-Type-FieldToMatch-Body"></a>
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.   
 AWS 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 AWS WAF for inspection.   
+ For Application Load Balancer and AWS 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 AWS Amplify, use the CloudFront limit.
For information about how to handle oversized request bodies, see the `Body` object configuration.   
Type: [Body](API_Body.md) object  
Required: No

 ** Cookies **   <a name="WAF-Type-FieldToMatch-Cookies"></a>
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 AWS WAF inspects.   
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize cookie content in the `Cookies` object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.   
Type: [Cookies](API_Cookies.md) object  
Required: No

 ** HeaderOrder **   <a name="WAF-Type-FieldToMatch-HeaderOrder"></a>
Inspect a string containing the list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and then uses that as the field to match component in its inspection. AWS WAF separates the header names in the string using colons and no added spaces, for example `host:user-agent:accept:authorization:referer`.  
Type: [HeaderOrder](API_HeaderOrder.md) object  
Required: No

 ** Headers **   <a name="WAF-Type-FieldToMatch-Headers"></a>
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 AWS WAF inspects.   
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize header content in the `Headers` object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.   
Type: [Headers](API_Headers.md) object  
Required: No

 ** JA3Fingerprint **   <a name="WAF-Type-FieldToMatch-JA3Fingerprint"></a>
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. AWS 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 AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS 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.  
Type: [JA3Fingerprint](API_JA3Fingerprint.md) object  
Required: No

 ** JA4Fingerprint **   <a name="WAF-Type-FieldToMatch-JA4Fingerprint"></a>
Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-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. AWS 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 JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS WAF Developer Guide*.   
Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.  
Type: [JA4Fingerprint](API_JA4Fingerprint.md) object  
Required: No

 ** JsonBody **   <a name="WAF-Type-FieldToMatch-JsonBody"></a>
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.   
 AWS 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 AWS WAF for inspection.   
+ For Application Load Balancer and AWS 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 AWS Amplify, use the CloudFront limit.
For information about how to handle oversized request bodies, see the `JsonBody` object configuration.   
Type: [JsonBody](API_JsonBody.md) object  
Required: No

 ** Method **   <a name="WAF-Type-FieldToMatch-Method"></a>
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.   
Type: [Method](API_Method.md) object  
Required: No

 ** QueryString **   <a name="WAF-Type-FieldToMatch-QueryString"></a>
Inspect the query string. This is the part of a URL that appears after a `?` character, if any.  
Type: [QueryString](API_QueryString.md) object  
Required: No

 ** SingleHeader **   <a name="WAF-Type-FieldToMatch-SingleHeader"></a>
Inspect a single header. Provide the name of the header to inspect, for example, `User-Agent` or `Referer`. This setting isn't case sensitive.  
Example JSON: `"SingleHeader": { "Name": "haystack" }`   
Alternately, you can filter and inspect all headers with the `Headers` `FieldToMatch` setting.   
Type: [SingleHeader](API_SingleHeader.md) object  
Required: No

 ** SingleQueryArgument **   <a name="WAF-Type-FieldToMatch-SingleQueryArgument"></a>
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" }`   
Type: [SingleQueryArgument](API_SingleQueryArgument.md) object  
Required: No

 ** UriFragment **   <a name="WAF-Type-FieldToMatch-UriFragment"></a>
Inspect fragments of the request URI. You must configure scope and pattern matching filters in the `UriFragment` object, to define the fragment of a URI that AWS WAF inspects.   
Only the first 8 KB (8192 bytes) of a request's URI fragments and only the first 200 URI fragments are forwarded to AWS WAF for inspection by the underlying host service. You must configure how to handle any oversize URI fragment content in the `UriFragment` object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.   
Type: [UriFragment](API_UriFragment.md) object  
Required: No

 ** UriPath **   <a name="WAF-Type-FieldToMatch-UriPath"></a>
Inspect the request URI path. This is the part of the web request that identifies a resource, for example, `/images/daily-ad.jpg`.  
Type: [UriPath](API_UriPath.md) object  
Required: No

## See Also
<a name="API_FieldToMatch_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/FieldToMatch) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/FieldToMatch) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/FieldToMatch) 

# FieldToProtect
<a name="API_FieldToProtect"></a>

Specifies a field type and keys to protect in stored web request data. This is part of the data protection configuration for a web ACL. 

## Contents
<a name="API_FieldToProtect_Contents"></a>

 ** FieldType **   <a name="WAF-Type-FieldToProtect-FieldType"></a>
Specifies the web request component type to protect.   
Type: String  
Valid Values: `SINGLE_HEADER | SINGLE_COOKIE | SINGLE_QUERY_ARGUMENT | QUERY_STRING | BODY`   
Required: Yes

 ** FieldKeys **   <a name="WAF-Type-FieldToProtect-FieldKeys"></a>
Specifies the keys to protect for the specified field type. If you don't specify any key, then all keys for the field type are protected.   
Type: Array of strings  
Array Members: Maximum number of 100 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_FieldToProtect_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/FieldToProtect) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/FieldToProtect) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/FieldToProtect) 

# Filter
<a name="API_Filter"></a>

A single logging filter, used in [LoggingFilter](API_LoggingFilter.md). 

## Contents
<a name="API_Filter_Contents"></a>

 ** Behavior **   <a name="WAF-Type-Filter-Behavior"></a>
How to handle logs that satisfy the filter's conditions and requirement.   
Type: String  
Valid Values: `KEEP | DROP`   
Required: Yes

 ** Conditions **   <a name="WAF-Type-Filter-Conditions"></a>
Match conditions for the filter.  
Type: Array of [Condition](API_Condition.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** Requirement **   <a name="WAF-Type-Filter-Requirement"></a>
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.  
Type: String  
Valid Values: `MEETS_ALL | MEETS_ANY`   
Required: Yes

## See Also
<a name="API_Filter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Filter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Filter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Filter) 

# FilterSource
<a name="API_FilterSource"></a>

Information about the bot filter that was applied to the request. This structure is populated in the response when you filter by bot category, organization, or name.

## Contents
<a name="API_FilterSource_Contents"></a>

 ** BotCategory **   <a name="WAF-Type-FilterSource-BotCategory"></a>
The bot category that was used to filter the results. For example, `ai` or `search_engine`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: No

 ** BotName **   <a name="WAF-Type-FilterSource-BotName"></a>
The bot name that was used to filter the results. For example, `gptbot` or `googlebot`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: No

 ** BotOrganization **   <a name="WAF-Type-FilterSource-BotOrganization"></a>
The bot organization that was used to filter the results. For example, `OpenAI` or `Google`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_FilterSource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/FilterSource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/FilterSource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/FilterSource) 

# FirewallManagerRuleGroup
<a name="API_FirewallManagerRuleGroup"></a>

A rule group that's defined for an AWS Firewall Manager AWS WAF policy.

## Contents
<a name="API_FirewallManagerRuleGroup_Contents"></a>

 ** FirewallManagerStatement **   <a name="WAF-Type-FirewallManagerRuleGroup-FirewallManagerStatement"></a>
The processing guidance for an AWS Firewall Manager rule. This is like a regular rule [Statement](API_Statement.md), but it can only contain a rule group reference.  
Type: [FirewallManagerStatement](API_FirewallManagerStatement.md) object  
Required: Yes

 ** Name **   <a name="WAF-Type-FirewallManagerRuleGroup-Name"></a>
The name of the rule group. You cannot change the name of a rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** OverrideAction **   <a name="WAF-Type-FirewallManagerRuleGroup-OverrideAction"></a>
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. 
Type: [OverrideAction](API_OverrideAction.md) object  
Required: Yes

 ** Priority **   <a name="WAF-Type-FirewallManagerRuleGroup-Priority"></a>
If you define more than one rule group in the first or last Firewall Manager rule groups, AWS 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.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** VisibilityConfig **   <a name="WAF-Type-FirewallManagerRuleGroup-VisibilityConfig"></a>
Defines and enables Amazon CloudWatch metrics and web request sample collection.   
Type: [VisibilityConfig](API_VisibilityConfig.md) object  
Required: Yes

## See Also
<a name="API_FirewallManagerRuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/FirewallManagerRuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/FirewallManagerRuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/FirewallManagerRuleGroup) 

# FirewallManagerStatement
<a name="API_FirewallManagerStatement"></a>

The processing guidance for an AWS Firewall Manager rule. This is like a regular rule [Statement](API_Statement.md), but it can only contain a single rule group reference.

## Contents
<a name="API_FirewallManagerStatement_Contents"></a>

 ** ManagedRuleGroupStatement **   <a name="WAF-Type-FirewallManagerStatement-ManagedRuleGroupStatement"></a>
A statement used by AWS Firewall Manager to run the rules that are defined in a managed rule group. This is managed by Firewall Manager for an AWS Firewall Manager AWS WAF policy.  
Type: [ManagedRuleGroupStatement](API_ManagedRuleGroupStatement.md) object  
Required: No

 ** RuleGroupReferenceStatement **   <a name="WAF-Type-FirewallManagerStatement-RuleGroupReferenceStatement"></a>
A statement used by AWS Firewall Manager to run the rules that are defined in a rule group. This is managed by Firewall Manager for an AWS Firewall Manager AWS WAF policy.  
Type: [RuleGroupReferenceStatement](API_RuleGroupReferenceStatement.md) object  
Required: No

## See Also
<a name="API_FirewallManagerStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/FirewallManagerStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/FirewallManagerStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/FirewallManagerStatement) 

# ForwardedIPConfig
<a name="API_ForwardedIPConfig"></a>

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. 

**Note**  
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This configuration is used for [GeoMatchStatement](API_GeoMatchStatement.md), [AsnMatchStatement](API_AsnMatchStatement.md), and [RateBasedStatement](API_RateBasedStatement.md). For [IPSetReferenceStatement](API_IPSetReferenceStatement.md), use [IPSetForwardedIPConfig](API_IPSetForwardedIPConfig.md) instead. 

 AWS WAF only evaluates the first IP address found in the specified HTTP header. 

## Contents
<a name="API_ForwardedIPConfig_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-ForwardedIPConfig-FallbackBehavior"></a>
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, AWS 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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

 ** HeaderName **   <a name="WAF-Type-ForwardedIPConfig-HeaderName"></a>
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, AWS WAF doesn't apply the rule to the web request at all.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

## See Also
<a name="API_ForwardedIPConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ForwardedIPConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ForwardedIPConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ForwardedIPConfig) 

# GeoMatchStatement
<a name="API_GeoMatchStatement"></a>

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. 

 AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). 

## Contents
<a name="API_GeoMatchStatement_Contents"></a>

 ** CountryCodes **   <a name="WAF-Type-GeoMatchStatement-CountryCodes"></a>
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.  
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Valid Values: `AF | AX | AL | DZ | AS | AD | AO | AI | AQ | AG | AR | AM | AW | AU | AT | AZ | BS | BH | BD | BB | BY | BE | BZ | BJ | BM | BT | BO | BQ | BA | BW | BV | BR | IO | BN | BG | BF | BI | KH | CM | CA | CV | KY | CF | TD | CL | CN | CX | CC | CO | KM | CG | CD | CK | CR | CI | HR | CU | CW | CY | CZ | DK | DJ | DM | DO | EC | EG | SV | GQ | ER | EE | ET | FK | FO | FJ | FI | FR | GF | PF | TF | GA | GM | GE | DE | GH | GI | GR | GL | GD | GP | GU | GT | GG | GN | GW | GY | HT | HM | VA | HN | HK | HU | IS | IN | ID | IR | IQ | IE | IM | IL | IT | JM | JP | JE | JO | KZ | KE | KI | KP | KR | KW | KG | LA | LV | LB | LS | LR | LY | LI | LT | LU | MO | MK | MG | MW | MY | MV | ML | MT | MH | MQ | MR | MU | YT | MX | FM | MD | MC | MN | ME | MS | MA | MZ | MM | NA | NR | NP | NL | NC | NZ | NI | NE | NG | NU | NF | MP | NO | OM | PK | PW | PS | PA | PG | PY | PE | PH | PN | PL | PT | PR | QA | RE | RO | RU | RW | BL | SH | KN | LC | MF | PM | VC | WS | SM | ST | SA | SN | RS | SC | SL | SG | SX | SK | SI | SB | SO | ZA | GS | SS | ES | LK | SD | SR | SJ | SZ | SE | CH | SY | TW | TJ | TZ | TH | TL | TG | TK | TO | TT | TN | TR | TM | TC | TV | UG | UA | AE | GB | US | UM | UY | UZ | VU | VE | VN | VG | VI | WF | EH | YE | ZM | ZW | XK`   
Required: No

 ** ForwardedIPConfig **   <a name="WAF-Type-GeoMatchStatement-ForwardedIPConfig"></a>
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, AWS WAF doesn't apply the rule to the web request at all.
Type: [ForwardedIPConfig](API_ForwardedIPConfig.md) object  
Required: No

## See Also
<a name="API_GeoMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/GeoMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/GeoMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/GeoMatchStatement) 

# HeaderMatchPattern
<a name="API_HeaderMatchPattern"></a>

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" ] }` 

## Contents
<a name="API_HeaderMatchPattern_Contents"></a>

 ** All **   <a name="WAF-Type-HeaderMatchPattern-All"></a>
Inspect all headers.   
Type: [All](API_All.md) object  
Required: No

 ** ExcludedHeaders **   <a name="WAF-Type-HeaderMatchPattern-ExcludedHeaders"></a>
Inspect only the headers whose keys don't match any of the strings specified here.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 199 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: No

 ** IncludedHeaders **   <a name="WAF-Type-HeaderMatchPattern-IncludedHeaders"></a>
Inspect only the headers that have a key that matches one of the strings specified here.   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 199 items.  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_HeaderMatchPattern_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/HeaderMatchPattern) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/HeaderMatchPattern) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/HeaderMatchPattern) 

# HeaderOrder
<a name="API_HeaderOrder"></a>

Inspect a string containing the list of the request's header names, ordered as they appear in the web request that AWS WAF receives for inspection. AWS WAF generates the string and then uses that as the field to match component in its inspection. AWS WAF separates the header names in the string using colons and no added spaces, for example `host:user-agent:accept:authorization:referer`.

## Contents
<a name="API_HeaderOrder_Contents"></a>

 ** OversizeHandling **   <a name="WAF-Type-HeaderOrder-OversizeHandling"></a>
What AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect. AWS 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 AWS 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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `CONTINUE | MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_HeaderOrder_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/HeaderOrder) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/HeaderOrder) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/HeaderOrder) 

# Headers
<a name="API_Headers"></a>

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](API_FieldToMatch.md) 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" }` 

## Contents
<a name="API_Headers_Contents"></a>

 ** MatchPattern **   <a name="WAF-Type-Headers-MatchPattern"></a>
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" ] }`   
Type: [HeaderMatchPattern](API_HeaderMatchPattern.md) object  
Required: Yes

 ** MatchScope **   <a name="WAF-Type-Headers-MatchScope"></a>
The parts of the headers to match with the rule inspection criteria. If you specify `ALL`, AWS 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 logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.   
Type: String  
Valid Values: `ALL | KEY | VALUE`   
Required: Yes

 ** OversizeHandling **   <a name="WAF-Type-Headers-OversizeHandling"></a>
What AWS WAF should do if the headers determined by your match scope are more numerous or larger than AWS WAF can inspect. AWS 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 AWS 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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `CONTINUE | MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_Headers_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Headers) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Headers) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Headers) 

# HTTPHeader
<a name="API_HTTPHeader"></a>

Part of the response from [GetSampledRequests](API_GetSampledRequests.md). 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. 

## Contents
<a name="API_HTTPHeader_Contents"></a>

 ** Name **   <a name="WAF-Type-HTTPHeader-Name"></a>
The name of the HTTP header.  
Type: String  
Required: No

 ** Value **   <a name="WAF-Type-HTTPHeader-Value"></a>
The value of the HTTP header.  
Type: String  
Required: No

## See Also
<a name="API_HTTPHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/HTTPHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/HTTPHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/HTTPHeader) 

# HTTPRequest
<a name="API_HTTPRequest"></a>

Part of the response from [GetSampledRequests](API_GetSampledRequests.md). This is a complex type that appears as `Request` in the response syntax. `HTTPRequest` contains information about one of the web requests. 

## Contents
<a name="API_HTTPRequest_Contents"></a>

 ** ClientIP **   <a name="WAF-Type-HTTPRequest-ClientIP"></a>
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
Type: String  
Required: No

 ** Country **   <a name="WAF-Type-HTTPRequest-Country"></a>
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](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).  
Type: String  
Required: No

 ** Headers **   <a name="WAF-Type-HTTPRequest-Headers"></a>
A complex type that contains the name and value for each header in the sampled web request.  
Type: Array of [HTTPHeader](API_HTTPHeader.md) objects  
Required: No

 ** HTTPVersion **   <a name="WAF-Type-HTTPRequest-HTTPVersion"></a>
The HTTP version specified in the sampled web request, for example, `HTTP/1.1`.  
Type: String  
Required: No

 ** Method **   <a name="WAF-Type-HTTPRequest-Method"></a>
The HTTP method specified in the sampled web request.   
Type: String  
Required: No

 ** URI **   <a name="WAF-Type-HTTPRequest-URI"></a>
The URI path of the request, which identifies the resource, for example, `/images/daily-ad.jpg`.  
Type: String  
Required: No

## See Also
<a name="API_HTTPRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/HTTPRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/HTTPRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/HTTPRequest) 

# ImmunityTimeProperty
<a name="API_ImmunityTimeProperty"></a>

Used for CAPTCHA and challenge token settings. Determines how long a `CAPTCHA` or challenge timestamp remains valid after AWS WAF updates it for a successful `CAPTCHA` or challenge response. 

## Contents
<a name="API_ImmunityTimeProperty_Contents"></a>

 ** ImmunityTime **   <a name="WAF-Type-ImmunityTimeProperty-ImmunityTime"></a>
The amount of time, in seconds, that a `CAPTCHA` or challenge timestamp is considered valid by AWS WAF. The default setting is 300.   
For the Challenge action, the minimum setting is 300.   
Type: Long  
Valid Range: Minimum value of 60. Maximum value of 259200.  
Required: Yes

## See Also
<a name="API_ImmunityTimeProperty_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ImmunityTimeProperty) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ImmunityTimeProperty) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ImmunityTimeProperty) 

# IPSet
<a name="API_IPSet"></a>

Contains zero or more IP addresses or blocks of IP addresses specified in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all IPv4 and IPv6 CIDR ranges except for /0. For information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). 

 AWS 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](API_Rule.md) statement [IPSetReferenceStatement](API_IPSetReferenceStatement.md). 

## Contents
<a name="API_IPSet_Contents"></a>

 ** Addresses **   <a name="WAF-Type-IPSet-Addresses"></a>
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want AWS WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. AWS 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](https://en.wikipedia.org/wiki/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 
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `.*\S.*`   
Required: Yes

 ** ARN **   <a name="WAF-Type-IPSet-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** Id **   <a name="WAF-Type-IPSet-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: Yes

 ** IPAddressVersion **   <a name="WAF-Type-IPSet-IPAddressVersion"></a>
The version of the IP addresses, either `IPV4` or `IPV6`.   
Type: String  
Valid Values: `IPV4 | IPV6`   
Required: Yes

 ** Name **   <a name="WAF-Type-IPSet-Name"></a>
The name of the IP set. You cannot change the name of an `IPSet` after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** Description **   <a name="WAF-Type-IPSet-Description"></a>
A description of the IP set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

## See Also
<a name="API_IPSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/IPSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/IPSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/IPSet) 

# IPSetForwardedIPConfig
<a name="API_IPSetForwardedIPConfig"></a>

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. 

**Note**  
If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.

This configuration is used only for [IPSetReferenceStatement](API_IPSetReferenceStatement.md). For [GeoMatchStatement](API_GeoMatchStatement.md) and [RateBasedStatement](API_RateBasedStatement.md), use [ForwardedIPConfig](API_ForwardedIPConfig.md) instead. 

## Contents
<a name="API_IPSetForwardedIPConfig_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-IPSetForwardedIPConfig-FallbackBehavior"></a>
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, AWS 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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

 ** HeaderName **   <a name="WAF-Type-IPSetForwardedIPConfig-HeaderName"></a>
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, AWS WAF doesn't apply the rule to the web request at all.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[a-zA-Z0-9-]+$`   
Required: Yes

 ** Position **   <a name="WAF-Type-IPSetForwardedIPConfig-Position"></a>
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, AWS WAF inspects the last 10.
Type: String  
Valid Values: `FIRST | LAST | ANY`   
Required: Yes

## See Also
<a name="API_IPSetForwardedIPConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/IPSetForwardedIPConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/IPSetForwardedIPConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/IPSetForwardedIPConfig) 

# IPSetReferenceStatement
<a name="API_IPSetReferenceStatement"></a>

A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an [IPSet](API_IPSet.md) 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](API_CreateIPSet.md).

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, AWS WAF automatically updates all rules that reference it.

## Contents
<a name="API_IPSetReferenceStatement_Contents"></a>

 ** ARN **   <a name="WAF-Type-IPSetReferenceStatement-ARN"></a>
The Amazon Resource Name (ARN) of the [IPSet](API_IPSet.md) that this statement references.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** IPSetForwardedIPConfig **   <a name="WAF-Type-IPSetReferenceStatement-IPSetForwardedIPConfig"></a>
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, AWS WAF doesn't apply the rule to the web request at all.
Type: [IPSetForwardedIPConfig](API_IPSetForwardedIPConfig.md) object  
Required: No

## See Also
<a name="API_IPSetReferenceStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/IPSetReferenceStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/IPSetReferenceStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/IPSetReferenceStatement) 

# IPSetSummary
<a name="API_IPSetSummary"></a>

High-level information about an [IPSet](API_IPSet.md), 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](API_IPSetReferenceStatement.md) to use the address set in a [Rule](API_Rule.md).

## Contents
<a name="API_IPSetSummary_Contents"></a>

 ** ARN **   <a name="WAF-Type-IPSetSummary-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-IPSetSummary-Description"></a>
A description of the IP set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-IPSetSummary-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** LockToken **   <a name="WAF-Type-IPSetSummary-LockToken"></a>
A token used for optimistic locking. AWS WAF returns a token to your `get` and `list` 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 like `update` and `delete`. AWS 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 a `WAFOptimisticLockException`. If this happens, perform another `get`, and use the new token returned by that operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-IPSetSummary-Name"></a>
The name of the IP set. You cannot change the name of an `IPSet` after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_IPSetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/IPSetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/IPSetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/IPSetSummary) 

# JA3Fingerprint
<a name="API_JA3Fingerprint"></a>

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. AWS 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.

**Note**  
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 AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS 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.

## Contents
<a name="API_JA3Fingerprint_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-JA3Fingerprint-FallbackBehavior"></a>
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. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_JA3Fingerprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/JA3Fingerprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/JA3Fingerprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/JA3Fingerprint) 

# JA4Fingerprint
<a name="API_JA4Fingerprint"></a>

Available for use with Amazon CloudFront distributions and Application Load Balancers. Match against the request's JA4 fingerprint. The JA4 fingerprint is a 36-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. AWS 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.

**Note**  
You can use this choice only with a string match `ByteMatchStatement` with the `PositionalConstraint` set to `EXACTLY`. 

You can obtain the JA4 fingerprint for client requests from the web ACL logs. If AWS WAF is able to calculate the fingerprint, it includes it in the logs. For information about the logging fields, see [Log fields](https://docs.aws.amazon.com/waf/latest/developerguide/logging-fields.html) in the * AWS WAF Developer Guide*. 

Provide the JA4 fingerprint string from the logs in your string match statement specification, to match with any future requests that have the same TLS configuration.

## Contents
<a name="API_JA4Fingerprint_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-JA4Fingerprint-FallbackBehavior"></a>
The match status to assign to the web request if the request doesn't have a JA4 fingerprint.   
You can specify the following fallback behaviors:  
+  `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_JA4Fingerprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/JA4Fingerprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/JA4Fingerprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/JA4Fingerprint) 

# JsonBody
<a name="API_JsonBody"></a>

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](API_FieldToMatch.md) specification. 

Use the specifications in this object to indicate which parts of the JSON body to inspect using the rule's inspection criteria. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the * AWS WAF Developer Guide*.

## Contents
<a name="API_JsonBody_Contents"></a>

 ** MatchPattern **   <a name="WAF-Type-JsonBody-MatchPattern"></a>
The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.   
Type: [JsonMatchPattern](API_JsonMatchPattern.md) object  
Required: Yes

 ** MatchScope **   <a name="WAF-Type-JsonBody-MatchScope"></a>
The parts of the JSON to match against using the `MatchPattern`. If you specify `ALL`, AWS 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 logical `AND` statement to combine two match rules, one that inspects the keys and another that inspects the values.   
Type: String  
Valid Values: `ALL | KEY | VALUE`   
Required: Yes

 ** InvalidFallbackBehavior **   <a name="WAF-Type-JsonBody-InvalidFallbackBehavior"></a>
What AWS 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. AWS 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. AWS 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, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.   
 AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the * AWS WAF Developer Guide*.
Type: String  
Valid Values: `MATCH | NO_MATCH | EVALUATE_AS_STRING`   
Required: No

 ** OversizeHandling **   <a name="WAF-Type-JsonBody-OversizeHandling"></a>
What AWS WAF should do if the body is larger than AWS WAF can inspect.   
 AWS 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 AWS WAF for inspection.   
+ For Application Load Balancer and AWS 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 AWS Amplify, use the CloudFront limit.
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. AWS 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` or `NO_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`   
Type: String  
Valid Values: `CONTINUE | MATCH | NO_MATCH`   
Required: No

## See Also
<a name="API_JsonBody_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/JsonBody) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/JsonBody) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/JsonBody) 

# JsonMatchPattern
<a name="API_JsonMatchPattern"></a>

The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria. This is used with the [FieldToMatch](API_FieldToMatch.md) option `JsonBody`. 

## Contents
<a name="API_JsonMatchPattern_Contents"></a>

 ** All **   <a name="WAF-Type-JsonMatchPattern-All"></a>
Match all of the elements. See also `MatchScope` in [JsonBody](API_JsonBody.md).   
You must specify either this setting or the `IncludedPaths` setting, but not both.  
Type: [All](API_All.md) object  
Required: No

 ** IncludedPaths **   <a name="WAF-Type-JsonMatchPattern-IncludedPaths"></a>
Match only the specified include paths. See also `MatchScope` in [JsonBody](API_JsonBody.md).   
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](https://tools.ietf.org/html/rfc6901).   
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. 
Type: Array of strings  
Array Members: Minimum number of 1 item.  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `([/])|([/](([^~])|(~[01]))+)`   
Required: No

## See Also
<a name="API_JsonMatchPattern_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/JsonMatchPattern) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/JsonMatchPattern) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/JsonMatchPattern) 

# Label
<a name="API_Label"></a>

A single label container. This is used as an element of a label array in multiple contexts, for example, in `RuleLabels` inside a [Rule](API_Rule.md) and in `Labels` inside a [SampledHTTPRequest](API_SampledHTTPRequest.md). 

## Contents
<a name="API_Label_Contents"></a>

 ** Name **   <a name="WAF-Type-Label-Name"></a>
The label string.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: Yes

## See Also
<a name="API_Label_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Label) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Label) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Label) 

# LabelMatchStatement
<a name="API_LabelMatchStatement"></a>

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, AWS WAF performs the search for labels that were added in the same context as the label match statement. 

## Contents
<a name="API_LabelMatchStatement_Contents"></a>

 ** Key **   <a name="WAF-Type-LabelMatchStatement-Key"></a>
The string to match against. The setting you provide for this depends on the match statement's `Scope` setting:   
+ If the `Scope` indicates `LABEL`, 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` indicates `NAMESPACE`, 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`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: Yes

 ** Scope **   <a name="WAF-Type-LabelMatchStatement-Scope"></a>
Specify whether you want to match using the label name or just the namespace.   
Type: String  
Valid Values: `LABEL | NAMESPACE`   
Required: Yes

## See Also
<a name="API_LabelMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/LabelMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/LabelMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/LabelMatchStatement) 

# LabelNameCondition
<a name="API_LabelNameCondition"></a>

A single label name condition for a [Condition](API_Condition.md) in a logging filter.

## Contents
<a name="API_LabelNameCondition_Contents"></a>

 ** LabelName **   <a name="WAF-Type-LabelNameCondition-LabelName"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: Yes

## See Also
<a name="API_LabelNameCondition_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/LabelNameCondition) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/LabelNameCondition) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/LabelNameCondition) 

# LabelSummary
<a name="API_LabelSummary"></a>

List of labels used by one or more of the rules of a [RuleGroup](API_RuleGroup.md). This summary object is used for the following rule group lists: 
+  `AvailableLabels` - Labels that rules add to matching requests. These labels are defined in the `RuleLabels` for a [Rule](API_Rule.md). 
+  `ConsumedLabels` - Labels that rules match against. These labels are defined in a `LabelMatchStatement` specification, in the [Statement](API_Statement.md) definition of a rule. 

## Contents
<a name="API_LabelSummary_Contents"></a>

 ** Name **   <a name="WAF-Type-LabelSummary-Name"></a>
An individual label specification.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: No

## See Also
<a name="API_LabelSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/LabelSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/LabelSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/LabelSummary) 

# LoggingConfiguration
<a name="API_LoggingConfiguration"></a>

Defines an association between logging destinations and a web ACL resource, for logging from AWS 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. 

If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs. 

**Note**  
You can define one logging destination per web ACL.

You can access information about the traffic that AWS WAF inspects using the following steps:

1. 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](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the * AWS WAF Developer Guide*.

1. Associate your logging destination to your web ACL using a `PutLoggingConfiguration` request.

When you successfully enable logging using a `PutLoggingConfiguration` request, AWS WAF creates an additional role or policy that is required to write logs to the logging destination. For an Amazon CloudWatch Logs log group, AWS WAF creates a resource policy on the log group. For an Amazon S3 bucket, AWS WAF creates a bucket policy. For an Amazon Kinesis Data Firehose, AWS WAF creates a service-linked role.

For additional information about web ACL logging, see [Logging web ACL traffic information](https://docs.aws.amazon.com/waf/latest/developerguide/logging.html) in the * AWS WAF Developer Guide*.

## Contents
<a name="API_LoggingConfiguration_Contents"></a>

 ** LogDestinationConfigs **   <a name="WAF-Type-LoggingConfiguration-LogDestinationConfigs"></a>
The logging destination configuration that you want to associate with the web ACL.  
You can associate one logging destination to a web ACL.
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 100 items.  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** ResourceArn **   <a name="WAF-Type-LoggingConfiguration-ResourceArn"></a>
The Amazon Resource Name (ARN) of the web ACL that you want to associate with `LogDestinationConfigs`.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** LoggingFilter **   <a name="WAF-Type-LoggingConfiguration-LoggingFilter"></a>
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.   
Type: [LoggingFilter](API_LoggingFilter.md) object  
Required: No

 ** LogScope **   <a name="WAF-Type-LoggingConfiguration-LogScope"></a>
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 AWS services](https://docs.aws.amazon.com/security-lake/latest/userguide/internal-sources.html) in the *Amazon Security Lake user guide*.   
The log scope `CLOUDWATCH_TELEMETRY_RULE_MANAGED` indicates a configuration that is managed through Amazon CloudWatch Logs for telemetry data collection and analysis. For information, see [What is Amazon CloudWatch Logs ?](https://docs.aws.amazon.com/AmazonCloudWatch/latest/logs/WhatIsCloudWatchLogs.html) in the *Amazon CloudWatch Logs user guide*.   
Default: `CUSTOMER`   
Type: String  
Valid Values: `CUSTOMER | SECURITY_LAKE | CLOUDWATCH_TELEMETRY_RULE_MANAGED`   
Required: No

 ** LogType **   <a name="WAF-Type-LoggingConfiguration-LogType"></a>
Used to distinguish between various logging options. Currently, there is one option.  
Default: `WAF_LOGS`   
Type: String  
Valid Values: `WAF_LOGS`   
Required: No

 ** ManagedByFirewallManager **   <a name="WAF-Type-LoggingConfiguration-ManagedByFirewallManager"></a>
Indicates whether the logging configuration was created by AWS Firewall Manager, as part of an AWS WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.   
The logging configuration can be created by AWS Firewall Manager for use with any web ACL that Firewall Manager is using for an AWS 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 their `RetrofittedByFirewallManager` property set to true. For either case, any corresponding logging configuration will indicate `ManagedByFirewallManager`.  
Type: Boolean  
Required: No

 ** RedactedFields **   <a name="WAF-Type-LoggingConfiguration-RedactedFields"></a>
The parts of the request that you want to keep out of the logs.  
For example, if you redact the `SingleHeader` field, the `HEADER` field in the logs will be `REDACTED` for all rules that use the `SingleHeader` `FieldToMatch` setting.   
If you configure data protection for the web ACL, the protection applies to the data that AWS WAF sends to the logs.   
Redaction applies only to the component that's specified in the rule's `FieldToMatch` setting, so the `SingleHeader` redaction doesn't apply to rules that use the `Headers` `FieldToMatch`.  
You can specify only the following fields for redaction: `UriPath`, `QueryString`, `SingleHeader`, and `Method`.
This setting has no impact on request sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.
Type: Array of [FieldToMatch](API_FieldToMatch.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

## See Also
<a name="API_LoggingConfiguration_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/LoggingConfiguration) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/LoggingConfiguration) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/LoggingConfiguration) 

# LoggingFilter
<a name="API_LoggingFilter"></a>

Filtering that specifies which web requests are kept in the logs and which are dropped, defined for a web ACL's [LoggingConfiguration](API_LoggingConfiguration.md). 

You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation. 

## Contents
<a name="API_LoggingFilter_Contents"></a>

 ** DefaultBehavior **   <a name="WAF-Type-LoggingFilter-DefaultBehavior"></a>
Default handling for logs that don't match any of the specified filtering conditions.   
Type: String  
Valid Values: `KEEP | DROP`   
Required: Yes

 ** Filters **   <a name="WAF-Type-LoggingFilter-Filters"></a>
The filters that you want to apply to the logs.   
Type: Array of [Filter](API_Filter.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_LoggingFilter_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/LoggingFilter) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/LoggingFilter) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/LoggingFilter) 

# ManagedProductDescriptor
<a name="API_ManagedProductDescriptor"></a>

The properties of a managed product, such as an AWS Managed Rules rule group or an AWS Marketplace managed rule group. 

## Contents
<a name="API_ManagedProductDescriptor_Contents"></a>

 ** IsAdvancedManagedRuleSet **   <a name="WAF-Type-ManagedProductDescriptor-IsAdvancedManagedRuleSet"></a>
Indicates whether the rule group provides an advanced set of protections, such as the the AWS Managed Rules rule groups that are used for AWS WAF intelligent threat mitigation.   
Type: Boolean  
Required: No

 ** IsVersioningSupported **   <a name="WAF-Type-ManagedProductDescriptor-IsVersioningSupported"></a>
Indicates whether the rule group is versioned.   
Type: Boolean  
Required: No

 ** ManagedRuleSetName **   <a name="WAF-Type-ManagedProductDescriptor-ManagedRuleSetName"></a>
The name of the managed rule group. For example, `AWSManagedRulesAnonymousIpList` or `AWSManagedRulesATPRuleSet`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** ProductDescription **   <a name="WAF-Type-ManagedProductDescriptor-ProductDescription"></a>
A short description of the managed rule group.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `.*\S.*`   
Required: No

 ** ProductId **   <a name="WAF-Type-ManagedProductDescriptor-ProductId"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: No

 ** ProductLink **   <a name="WAF-Type-ManagedProductDescriptor-ProductLink"></a>
For AWS Marketplace managed rule groups only, the link to the rule group product page.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** ProductTitle **   <a name="WAF-Type-ManagedProductDescriptor-ProductTitle"></a>
The display name for the managed rule group. For example, `Anonymous IP list` or `Account takeover prevention`.  
Type: String  
Length Constraints: Minimum length of 1.  
Pattern: `.*\S.*`   
Required: No

 ** SnsTopicArn **   <a name="WAF-Type-ManagedProductDescriptor-SnsTopicArn"></a>
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](https://docs.aws.amazon.com/sns/latest/dg/welcome.html).  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** VendorName **   <a name="WAF-Type-ManagedProductDescriptor-VendorName"></a>
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: No

## See Also
<a name="API_ManagedProductDescriptor_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedProductDescriptor) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedProductDescriptor) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedProductDescriptor) 

# ManagedRuleGroupConfig
<a name="API_ManagedRuleGroupConfig"></a>

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 `AWSManagedRulesAntiDDoSRuleSet` configuration object to configure the anti-DDoS managed rule group. The configuration includes the sensitivity levels to use in the rules that typically block and challenge requests that might be participating in DDoS attacks and the specification to use to indicate whether a request can handle a silent browser challenge. 
+ 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](API_CreateWebACL.md).

## Contents
<a name="API_ManagedRuleGroupConfig_Contents"></a>

 ** AWSManagedRulesACFPRuleSet **   <a name="WAF-Type-ManagedRuleGroupConfig-AWSManagedRulesACFPRuleSet"></a>
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 [AWS WAF Fraud Control account creation fraud prevention (ACFP) rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-acfp.html) and [AWS WAF Fraud Control account creation fraud prevention (ACFP)](https://docs.aws.amazon.com/waf/latest/developerguide/waf-acfp.html) in the * AWS WAF Developer Guide*.  
Type: [AWSManagedRulesACFPRuleSet](API_AWSManagedRulesACFPRuleSet.md) object  
Required: No

 ** AWSManagedRulesAntiDDoSRuleSet **   <a name="WAF-Type-ManagedRuleGroupConfig-AWSManagedRulesAntiDDoSRuleSet"></a>
Additional configuration for using the anti-DDoS managed rule group, `AWSManagedRulesAntiDDoSRuleSet`. Use this to configure anti-DDoS behavior for the rule group.   
For information about using the anti-DDoS managed rule group, see [AWS WAF Anti-DDoS rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-anti-ddos.html) and [Distributed Denial of Service (DDoS) prevention](https://docs.aws.amazon.com/waf/latest/developerguide/waf-anti-ddos.html) in the * AWS WAF Developer Guide*.  
Type: [AWSManagedRulesAntiDDoSRuleSet](API_AWSManagedRulesAntiDDoSRuleSet.md) object  
Required: No

 ** AWSManagedRulesATPRuleSet **   <a name="WAF-Type-ManagedRuleGroupConfig-AWSManagedRulesATPRuleSet"></a>
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 [AWS WAF Fraud Control account takeover prevention (ATP) rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-atp.html) and [AWS WAF Fraud Control account takeover prevention (ATP)](https://docs.aws.amazon.com/waf/latest/developerguide/waf-atp.html) in the * AWS WAF Developer Guide*.  
Type: [AWSManagedRulesATPRuleSet](API_AWSManagedRulesATPRuleSet.md) object  
Required: No

 ** AWSManagedRulesBotControlRuleSet **   <a name="WAF-Type-ManagedRuleGroupConfig-AWSManagedRulesBotControlRuleSet"></a>
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 [AWS WAF Bot Control rule group](https://docs.aws.amazon.com/waf/latest/developerguide/aws-managed-rule-groups-bot.html) and [AWS WAF Bot Control](https://docs.aws.amazon.com/waf/latest/developerguide/waf-bot-control.html) in the * AWS WAF Developer Guide*.  
Type: [AWSManagedRulesBotControlRuleSet](API_AWSManagedRulesBotControlRuleSet.md) object  
Required: No

 ** LoginPath **   <a name="WAF-Type-ManagedRuleGroupConfig-LoginPath"></a>
 *This member has been deprecated.*   
Instead of this setting, provide your configuration under `AWSManagedRulesATPRuleSet`. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `.*\S.*`   
Required: No

 ** PasswordField **   <a name="WAF-Type-ManagedRuleGroupConfig-PasswordField"></a>
 *This member has been deprecated.*   
Instead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`. 
Type: [PasswordField](API_PasswordField.md) object  
Required: No

 ** PayloadType **   <a name="WAF-Type-ManagedRuleGroupConfig-PayloadType"></a>
 *This member has been deprecated.*   
Instead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`. 
Type: String  
Valid Values: `JSON | FORM_ENCODED`   
Required: No

 ** UsernameField **   <a name="WAF-Type-ManagedRuleGroupConfig-UsernameField"></a>
 *This member has been deprecated.*   
Instead of this setting, provide your configuration under the request inspection configuration for `AWSManagedRulesATPRuleSet` or `AWSManagedRulesACFPRuleSet`. 
Type: [UsernameField](API_UsernameField.md) object  
Required: No

## See Also
<a name="API_ManagedRuleGroupConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleGroupConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleGroupConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleGroupConfig) 

# ManagedRuleGroupStatement
<a name="API_ManagedRuleGroupStatement"></a>

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](API_ListAvailableManagedRuleGroups.md).

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.

**Note**  
You are charged additional fees when you use the AWS WAF Bot Control managed rule group `AWSManagedRulesBotControlRuleSet`, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group `AWSManagedRulesATPRuleSet`, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group `AWSManagedRulesACFPRuleSet`. For more information, see [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).

## Contents
<a name="API_ManagedRuleGroupStatement_Contents"></a>

 ** Name **   <a name="WAF-Type-ManagedRuleGroupStatement-Name"></a>
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** VendorName **   <a name="WAF-Type-ManagedRuleGroupStatement-VendorName"></a>
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: Yes

 ** ExcludedRules **   <a name="WAF-Type-ManagedRuleGroupStatement-ExcludedRules"></a>
Rules in the referenced rule group whose actions are set to `Count`.   
Instead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.
Type: Array of [ExcludedRule](API_ExcludedRule.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** ManagedRuleGroupConfigs **   <a name="WAF-Type-ManagedRuleGroupStatement-ManagedRuleGroupConfigs"></a>
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 `AWSManagedRulesAntiDDoSRuleSet` configuration object to configure the anti-DDoS managed rule group. The configuration includes the sensitivity levels to use in the rules that typically block and challenge requests that might be participating in DDoS attacks and the specification to use to indicate whether a request can handle a silent browser challenge. 
+ 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. 
Type: Array of [ManagedRuleGroupConfig](API_ManagedRuleGroupConfig.md) objects  
Required: No

 ** RuleActionOverrides **   <a name="WAF-Type-ManagedRuleGroupStatement-RuleActionOverrides"></a>
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.   
Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.
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.  
Type: Array of [RuleActionOverride](API_RuleActionOverride.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** ScopeDownStatement **   <a name="WAF-Type-ManagedRuleGroupStatement-ScopeDownStatement"></a>
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](API_Statement.md) in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.   
Type: [Statement](API_Statement.md) object  
Required: No

 ** Version **   <a name="WAF-Type-ManagedRuleGroupStatement-Version"></a>
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, AWS 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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w#:\.\-/]+$`   
Required: No

## See Also
<a name="API_ManagedRuleGroupStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleGroupStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleGroupStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleGroupStatement) 

# ManagedRuleGroupSummary
<a name="API_ManagedRuleGroupSummary"></a>

High-level information about a managed rule group, returned by [ListAvailableManagedRuleGroups](API_ListAvailableManagedRuleGroups.md). This provides information like the name and vendor name, that you provide when you add a [ManagedRuleGroupStatement](API_ManagedRuleGroupStatement.md) to a web ACL. Managed rule groups include AWS Managed Rules rule groups and AWS Marketplace managed rule groups. To use any AWS Marketplace managed rule group, first subscribe to the rule group through AWS Marketplace. 

## Contents
<a name="API_ManagedRuleGroupSummary_Contents"></a>

 ** Description **   <a name="WAF-Type-ManagedRuleGroupSummary-Description"></a>
The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Name **   <a name="WAF-Type-ManagedRuleGroupSummary-Name"></a>
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** VendorName **   <a name="WAF-Type-ManagedRuleGroupSummary-VendorName"></a>
The name of the managed rule group vendor. You use this, along with the rule group name, to identify a rule group.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `.*\S.*`   
Required: No

 ** VersioningSupported **   <a name="WAF-Type-ManagedRuleGroupSummary-VersioningSupported"></a>
Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling [ListAvailableManagedRuleGroupVersions](API_ListAvailableManagedRuleGroupVersions.md).   
Type: Boolean  
Required: No

## See Also
<a name="API_ManagedRuleGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleGroupSummary) 

# ManagedRuleGroupVersion
<a name="API_ManagedRuleGroupVersion"></a>

Describes a single version of a managed rule group. 

## Contents
<a name="API_ManagedRuleGroupVersion_Contents"></a>

 ** LastUpdateTimestamp **   <a name="WAF-Type-ManagedRuleGroupVersion-LastUpdateTimestamp"></a>
The date and time that the managed rule group owner updated the rule group version information.   
Type: Timestamp  
Required: No

 ** Name **   <a name="WAF-Type-ManagedRuleGroupVersion-Name"></a>
The version name.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w#:\.\-/]+$`   
Required: No

## See Also
<a name="API_ManagedRuleGroupVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleGroupVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleGroupVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleGroupVersion) 

# ManagedRuleSet
<a name="API_ManagedRuleSet"></a>

A set of rules that is managed by AWS and AWS Marketplace sellers to provide versioned managed rule groups for customers of AWS WAF.

**Note**  
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS 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`.

## Contents
<a name="API_ManagedRuleSet_Contents"></a>

 ** ARN **   <a name="WAF-Type-ManagedRuleSet-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** Id **   <a name="WAF-Type-ManagedRuleSet-Id"></a>
A unique identifier for the managed rule set. The ID is returned in the responses to commands like `list`. You provide it to operations like `get` and `update`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: Yes

 ** Name **   <a name="WAF-Type-ManagedRuleSet-Name"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** Description **   <a name="WAF-Type-ManagedRuleSet-Description"></a>
A description of the set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** LabelNamespace **   <a name="WAF-Type-ManagedRuleSet-LabelNamespace"></a>
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, AWS 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>` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: No

 ** PublishedVersions **   <a name="WAF-Type-ManagedRuleSet-PublishedVersions"></a>
The versions of this managed rule set that are available for use by customers.   
Type: String to [ManagedRuleSetVersion](API_ManagedRuleSetVersion.md) object map  
Key Length Constraints: Minimum length of 1. Maximum length of 64.  
Key Pattern: `^[\w#:\.\-/]+$`   
Required: No

 ** RecommendedVersion **   <a name="WAF-Type-ManagedRuleSet-RecommendedVersion"></a>
The version that you would like your customers to use.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w#:\.\-/]+$`   
Required: No

## See Also
<a name="API_ManagedRuleSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleSet) 

# ManagedRuleSetSummary
<a name="API_ManagedRuleSetSummary"></a>

High-level information for a managed rule set. 

**Note**  
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS 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`.

## Contents
<a name="API_ManagedRuleSetSummary_Contents"></a>

 ** ARN **   <a name="WAF-Type-ManagedRuleSetSummary-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-ManagedRuleSetSummary-Description"></a>
A description of the set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-ManagedRuleSetSummary-Id"></a>
A unique identifier for the managed rule set. The ID is returned in the responses to commands like `list`. You provide it to operations like `get` and `update`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** LabelNamespace **   <a name="WAF-Type-ManagedRuleSetSummary-LabelNamespace"></a>
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, AWS 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>` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: No

 ** LockToken **   <a name="WAF-Type-ManagedRuleSetSummary-LockToken"></a>
A token used for optimistic locking. AWS WAF returns a token to your `get` and `list` 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 like `update` and `delete`. AWS 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 a `WAFOptimisticLockException`. If this happens, perform another `get`, and use the new token returned by that operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-ManagedRuleSetSummary-Name"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_ManagedRuleSetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleSetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleSetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleSetSummary) 

# ManagedRuleSetVersion
<a name="API_ManagedRuleSetVersion"></a>

Information for a single version of a managed rule set. 

**Note**  
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS 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`.

## Contents
<a name="API_ManagedRuleSetVersion_Contents"></a>

 ** AssociatedRuleGroupArn **   <a name="WAF-Type-ManagedRuleSetVersion-AssociatedRuleGroupArn"></a>
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Capacity **   <a name="WAF-Type-ManagedRuleSetVersion-Capacity"></a>
The web ACL capacity units (WCUs) required for this rule group.  
 AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [AWS WAF web ACL capacity units (WCU)](https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) in the * AWS WAF Developer Guide*.   
Type: Long  
Valid Range: Minimum value of 1.  
Required: No

 ** ExpiryTimestamp **   <a name="WAF-Type-ManagedRuleSetVersion-ExpiryTimestamp"></a>
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".   
Type: Timestamp  
Required: No

 ** ForecastedLifetime **   <a name="WAF-Type-ManagedRuleSetVersion-ForecastedLifetime"></a>
The amount of time you expect this version of your managed rule group to last, in days.   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

 ** LastUpdateTimestamp **   <a name="WAF-Type-ManagedRuleSetVersion-LastUpdateTimestamp"></a>
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".   
Type: Timestamp  
Required: No

 ** PublishTimestamp **   <a name="WAF-Type-ManagedRuleSetVersion-PublishTimestamp"></a>
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".   
Type: Timestamp  
Required: No

## See Also
<a name="API_ManagedRuleSetVersion_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ManagedRuleSetVersion) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ManagedRuleSetVersion) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ManagedRuleSetVersion) 

# Method
<a name="API_Method"></a>

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](API_FieldToMatch.md) specification for some web request component types. 

JSON specification: `"Method": {}` 

## Contents
<a name="API_Method_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_Method_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Method) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Method) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Method) 

# MobileSdkRelease
<a name="API_MobileSdkRelease"></a>

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 AWS WAF tokens for use in HTTP(S) requests from a mobile device to AWS WAF. For more information, see [AWS WAF client application integration](https://docs.aws.amazon.com/waf/latest/developerguide/waf-application-integration.html) in the * AWS WAF Developer Guide*.

## Contents
<a name="API_MobileSdkRelease_Contents"></a>

 ** ReleaseNotes **   <a name="WAF-Type-MobileSdkRelease-ReleaseNotes"></a>
Notes describing the release.  
Type: String  
Required: No

 ** ReleaseVersion **   <a name="WAF-Type-MobileSdkRelease-ReleaseVersion"></a>
The release version.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w#:\.\-/]+$`   
Required: No

 ** Tags **   <a name="WAF-Type-MobileSdkRelease-Tags"></a>
Tags that are associated with the release.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

 ** Timestamp **   <a name="WAF-Type-MobileSdkRelease-Timestamp"></a>
The timestamp of the release.   
Type: Timestamp  
Required: No

## See Also
<a name="API_MobileSdkRelease_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/MobileSdkRelease) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/MobileSdkRelease) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/MobileSdkRelease) 

# NoneAction
<a name="API_NoneAction"></a>

Specifies that AWS WAF should do nothing. This is used for the `OverrideAction` setting on a [Rule](API_Rule.md) 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](API_RuleAction.md) and web ACL [DefaultAction](API_DefaultAction.md). 

JSON specification: `"None": {}` 

## Contents
<a name="API_NoneAction_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_NoneAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/NoneAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/NoneAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/NoneAction) 

# NotStatement
<a name="API_NotStatement"></a>

A logical rule statement used to negate the results of another rule statement. You provide one [Statement](API_Statement.md) within the `NotStatement`.

## Contents
<a name="API_NotStatement_Contents"></a>

 ** Statement **   <a name="WAF-Type-NotStatement-Statement"></a>
The statement to negate. You can use any statement that can be nested.  
Type: [Statement](API_Statement.md) object  
Required: Yes

## See Also
<a name="API_NotStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/NotStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/NotStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/NotStatement) 

# OnSourceDDoSProtectionConfig
<a name="API_OnSourceDDoSProtectionConfig"></a>

Configures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.

## Contents
<a name="API_OnSourceDDoSProtectionConfig_Contents"></a>

 ** ALBLowReputationMode **   <a name="WAF-Type-OnSourceDDoSProtectionConfig-ALBLowReputationMode"></a>
The level of DDoS protection that applies to web ACLs associated with Application Load Balancers. `ACTIVE_UNDER_DDOS` protection is enabled by default whenever a web ACL is associated with an Application Load Balancer. In the event that an Application Load Balancer experiences high-load conditions or suspected DDoS attacks, the `ACTIVE_UNDER_DDOS` protection automatically rate limits traffic from known low reputation sources without disrupting Application Load Balancer availability. `ALWAYS_ON` protection provides constant, always-on monitoring of known low reputation sources for suspected DDoS attacks. While this provides a higher level of protection, there may be potential impacts on legitimate traffic.  
Type: String  
Valid Values: `ACTIVE_UNDER_DDOS | ALWAYS_ON`   
Required: Yes

## See Also
<a name="API_OnSourceDDoSProtectionConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/OnSourceDDoSProtectionConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/OnSourceDDoSProtectionConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/OnSourceDDoSProtectionConfig) 

# OrStatement
<a name="API_OrStatement"></a>

A logical rule statement used to combine other rule statements with OR logic. You provide more than one [Statement](API_Statement.md) within the `OrStatement`. 

## Contents
<a name="API_OrStatement_Contents"></a>

 ** Statements **   <a name="WAF-Type-OrStatement-Statements"></a>
The statements to combine with OR logic. You can use any statements that can be nested.  
Type: Array of [Statement](API_Statement.md) objects  
Required: Yes

## See Also
<a name="API_OrStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/OrStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/OrStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/OrStatement) 

# OverrideAction
<a name="API_OverrideAction"></a>

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`. 

**Note**  
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. 

## Contents
<a name="API_OverrideAction_Contents"></a>

 ** Count **   <a name="WAF-Type-OverrideAction-Count"></a>
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. 
Type: [CountAction](API_CountAction.md) object  
Required: No

 ** None **   <a name="WAF-Type-OverrideAction-None"></a>
Don't override the rule group evaluation result. This is the most common setting.  
Type: [NoneAction](API_NoneAction.md) object  
Required: No

## See Also
<a name="API_OverrideAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/OverrideAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/OverrideAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/OverrideAction) 

# PasswordField
<a name="API_PasswordField"></a>

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. 

## Contents
<a name="API_PasswordField_Contents"></a>

 ** Identifier **   <a name="WAF-Type-PasswordField-Identifier"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `password1`.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_PasswordField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/PasswordField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/PasswordField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/PasswordField) 

# PathStatistics
<a name="API_PathStatistics"></a>

Statistics about bot traffic to a specific URI path, including the path, request count, percentage of total traffic, and the top bots accessing that path.

## Contents
<a name="API_PathStatistics_Contents"></a>

 ** Path **   <a name="WAF-Type-PathStatistics-Path"></a>
The URI path. For example, `/api/` or `/api/v1/users`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Required: Yes

 ** Percentage **   <a name="WAF-Type-PathStatistics-Percentage"></a>
The percentage of total requests that were made to this path.  
Type: Double  
Valid Range: Minimum value of 0.0. Maximum value of 100.0.  
Required: Yes

 ** RequestCount **   <a name="WAF-Type-PathStatistics-RequestCount"></a>
The number of requests to this path within the specified time window.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Source **   <a name="WAF-Type-PathStatistics-Source"></a>
Information about the bot filter that was applied to generate these statistics. This field is only populated when you filter by bot category, organization, or name.  
Type: [FilterSource](API_FilterSource.md) object  
Required: No

 ** TopBots **   <a name="WAF-Type-PathStatistics-TopBots"></a>
The list of top bots accessing this path, ordered by request count. The number of bots included is determined by the `NumberOfTopTrafficBotsPerPath` parameter in the request.  
Type: Array of [BotStatistics](API_BotStatistics.md) objects  
Required: No

## See Also
<a name="API_PathStatistics_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/PathStatistics) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/PathStatistics) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/PathStatistics) 

# PhoneNumberField
<a name="API_PhoneNumberField"></a>

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. 

## Contents
<a name="API_PhoneNumberField_Contents"></a>

 ** Identifier **   <a name="WAF-Type-PhoneNumberField-Identifier"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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`, and `primaryphoneline3`, the phone number field identifiers are `primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`. 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_PhoneNumberField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/PhoneNumberField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/PhoneNumberField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/PhoneNumberField) 

# QueryString
<a name="API_QueryString"></a>

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](API_FieldToMatch.md) specification for some web request component types. 

JSON specification: `"QueryString": {}` 

## Contents
<a name="API_QueryString_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_QueryString_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/QueryString) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/QueryString) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/QueryString) 

# RateBasedStatement
<a name="API_RateBasedStatement"></a>

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. 

**Note**  
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 AWS 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 AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) in the * AWS 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 AWS WAF is currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available for other aggregation configurations.

 AWS 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 AWS 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 AWS WAF. 

## Contents
<a name="API_RateBasedStatement_Contents"></a>

 ** AggregateKeyType **   <a name="WAF-Type-RateBasedStatement-AggregateKeyType"></a>
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, AWS 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` or `FORWARDED_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`. 
Type: String  
Valid Values: `IP | FORWARDED_IP | CUSTOM_KEYS | CONSTANT`   
Required: Yes

 ** Limit **   <a name="WAF-Type-RateBasedStatement-Limit"></a>
The limit on requests during the specified evaluation window 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. 
Type: Long  
Valid Range: Minimum value of 10. Maximum value of 2000000000.  
Required: Yes

 ** CustomKeys **   <a name="WAF-Type-RateBasedStatement-CustomKeys"></a>
Specifies the aggregate keys to use in a rate-base rule.   
Type: Array of [RateBasedStatementCustomKey](API_RateBasedStatementCustomKey.md) objects  
Array Members: Maximum number of 5 items.  
Required: No

 ** EvaluationWindowSec **   <a name="WAF-Type-RateBasedStatement-EvaluationWindowSec"></a>
The amount of time, in seconds, that AWS WAF should include in its request counts, looking back from the current time. For example, for a setting of 120, when AWS 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 AWS WAF checks the rate, but how far back it looks each time it checks. AWS WAF checks the rate about every 10 seconds.  
Default: `300` (5 minutes)  
Type: Long  
Required: No

 ** ForwardedIPConfig **   <a name="WAF-Type-RateBasedStatement-ForwardedIPConfig"></a>
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, AWS 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.   
Type: [ForwardedIPConfig](API_ForwardedIPConfig.md) object  
Required: No

 ** ScopeDownStatement **   <a name="WAF-Type-RateBasedStatement-ScopeDownStatement"></a>
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](API_Statement.md) in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.   
Type: [Statement](API_Statement.md) object  
Required: No

## See Also
<a name="API_RateBasedStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateBasedStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateBasedStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateBasedStatement) 

# RateBasedStatementCustomKey
<a name="API_RateBasedStatementCustomKey"></a>

Specifies a single custom aggregate key for a rate-base rule. 

**Note**  
Web requests that are missing any of the components specified in the aggregation keys are omitted from the rate-based rule evaluation and handling. 

## Contents
<a name="API_RateBasedStatementCustomKey_Contents"></a>

 ** ASN **   <a name="WAF-Type-RateBasedStatementCustomKey-ASN"></a>
Use an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key. Each distinct ASN contributes to the aggregation instance.   
Type: [RateLimitAsn](API_RateLimitAsn.md) object  
Required: No

 ** Cookie **   <a name="WAF-Type-RateBasedStatementCustomKey-Cookie"></a>
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.   
Type: [RateLimitCookie](API_RateLimitCookie.md) object  
Required: No

 ** ForwardedIP **   <a name="WAF-Type-RateBasedStatementCustomKey-ForwardedIP"></a>
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's `AggregateKeyType`.   
With this option, you must specify the header to use in the rate-based rule's `ForwardedIPConfig` property.   
Type: [RateLimitForwardedIP](API_RateLimitForwardedIP.md) object  
Required: No

 ** Header **   <a name="WAF-Type-RateBasedStatementCustomKey-Header"></a>
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.   
Type: [RateLimitHeader](API_RateLimitHeader.md) object  
Required: No

 ** HTTPMethod **   <a name="WAF-Type-RateBasedStatementCustomKey-HTTPMethod"></a>
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.   
Type: [RateLimitHTTPMethod](API_RateLimitHTTPMethod.md) object  
Required: No

 ** IP **   <a name="WAF-Type-RateBasedStatementCustomKey-IP"></a>
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's `AggregateKeyType`.   
Type: [RateLimitIP](API_RateLimitIP.md) object  
Required: No

 ** JA3Fingerprint **   <a name="WAF-Type-RateBasedStatementCustomKey-JA3Fingerprint"></a>
 Use the request's JA3 fingerprint as an aggregate key. If you use a single JA3 fingerprint as your custom key, then each value fully defines an aggregation instance.   
Type: [RateLimitJA3Fingerprint](API_RateLimitJA3Fingerprint.md) object  
Required: No

 ** JA4Fingerprint **   <a name="WAF-Type-RateBasedStatementCustomKey-JA4Fingerprint"></a>
Use the request's JA4 fingerprint as an aggregate key. If you use a single JA4 fingerprint as your custom key, then each value fully defines an aggregation instance.   
Type: [RateLimitJA4Fingerprint](API_RateLimitJA4Fingerprint.md) object  
Required: No

 ** LabelNamespace **   <a name="WAF-Type-RateBasedStatementCustomKey-LabelNamespace"></a>
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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the * AWS WAF Developer Guide*.  
Type: [RateLimitLabelNamespace](API_RateLimitLabelNamespace.md) object  
Required: No

 ** QueryArgument **   <a name="WAF-Type-RateBasedStatementCustomKey-QueryArgument"></a>
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.   
Type: [RateLimitQueryArgument](API_RateLimitQueryArgument.md) object  
Required: No

 ** QueryString **   <a name="WAF-Type-RateBasedStatementCustomKey-QueryString"></a>
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.   
Type: [RateLimitQueryString](API_RateLimitQueryString.md) object  
Required: No

 ** UriPath **   <a name="WAF-Type-RateBasedStatementCustomKey-UriPath"></a>
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.   
Type: [RateLimitUriPath](API_RateLimitUriPath.md) object  
Required: No

## See Also
<a name="API_RateBasedStatementCustomKey_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateBasedStatementCustomKey) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateBasedStatementCustomKey) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateBasedStatementCustomKey) 

# RateBasedStatementManagedKeysIPSet
<a name="API_RateBasedStatementManagedKeysIPSet"></a>

The set of IP addresses that are currently blocked for a [RateBasedStatement](API_RateBasedStatement.md). 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, AWS WAF limits those with the highest rates. 

## Contents
<a name="API_RateBasedStatementManagedKeysIPSet_Contents"></a>

 ** Addresses **   <a name="WAF-Type-RateBasedStatementManagedKeysIPSet-Addresses"></a>
The IP addresses that are currently blocked.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 50.  
Pattern: `.*\S.*`   
Required: No

 ** IPAddressVersion **   <a name="WAF-Type-RateBasedStatementManagedKeysIPSet-IPAddressVersion"></a>
The version of the IP addresses, either `IPV4` or `IPV6`.   
Type: String  
Valid Values: `IPV4 | IPV6`   
Required: No

## See Also
<a name="API_RateBasedStatementManagedKeysIPSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateBasedStatementManagedKeysIPSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateBasedStatementManagedKeysIPSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateBasedStatementManagedKeysIPSet) 

# RateLimitAsn
<a name="API_RateLimitAsn"></a>

Specifies an Autonomous System Number (ASN) derived from the request's originating or forwarded IP address as an aggregate key for a rate-based rule. Each distinct ASN contributes to the aggregation instance. If you use a single ASN as your custom key, then each ASN fully defines an aggregation instance. 

## Contents
<a name="API_RateLimitAsn_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_RateLimitAsn_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitAsn) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitAsn) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitAsn) 

# RateLimitCookie
<a name="API_RateLimitCookie"></a>

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. 

## Contents
<a name="API_RateLimitCookie_Contents"></a>

 ** Name **   <a name="WAF-Type-RateLimitCookie-Name"></a>
The name of the cookie to use.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-RateLimitCookie-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RateLimitCookie_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitCookie) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitCookie) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitCookie) 

# RateLimitForwardedIP
<a name="API_RateLimitForwardedIP"></a>

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`. 

## Contents
<a name="API_RateLimitForwardedIP_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_RateLimitForwardedIP_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitForwardedIP) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitForwardedIP) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitForwardedIP) 

# RateLimitHeader
<a name="API_RateLimitHeader"></a>

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. 

## Contents
<a name="API_RateLimitHeader_Contents"></a>

 ** Name **   <a name="WAF-Type-RateLimitHeader-Name"></a>
The name of the header to use.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-RateLimitHeader-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RateLimitHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitHeader) 

# RateLimitHTTPMethod
<a name="API_RateLimitHTTPMethod"></a>

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": {}` 

## Contents
<a name="API_RateLimitHTTPMethod_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_RateLimitHTTPMethod_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitHTTPMethod) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitHTTPMethod) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitHTTPMethod) 

# RateLimitIP
<a name="API_RateLimitIP"></a>

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": {}` 

## Contents
<a name="API_RateLimitIP_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_RateLimitIP_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitIP) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitIP) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitIP) 

# RateLimitJA3Fingerprint
<a name="API_RateLimitJA3Fingerprint"></a>

 Use the request's JA3 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA3 fingerprint as your custom key, then each value fully defines an aggregation instance. 

## Contents
<a name="API_RateLimitJA3Fingerprint_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-RateLimitJA3Fingerprint-FallbackBehavior"></a>
The match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA3 fingerprint.  
You can specify the following fallback behaviors:  
+  `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_RateLimitJA3Fingerprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitJA3Fingerprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitJA3Fingerprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitJA3Fingerprint) 

# RateLimitJA4Fingerprint
<a name="API_RateLimitJA4Fingerprint"></a>

Use the request's JA4 fingerprint derived from the TLS Client Hello of an incoming request as an aggregate key. If you use a single JA4 fingerprint as your custom key, then each value fully defines an aggregation instance.

## Contents
<a name="API_RateLimitJA4Fingerprint_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-RateLimitJA4Fingerprint-FallbackBehavior"></a>
The match status to assign to the web request if there is insufficient TSL Client Hello information to compute the JA4 fingerprint.  
You can specify the following fallback behaviors:  
+  `MATCH` - Treat the web request as matching the rule statement. AWS WAF applies the rule action to the request.
+  `NO_MATCH` - Treat the web request as not matching the rule statement.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: Yes

## See Also
<a name="API_RateLimitJA4Fingerprint_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitJA4Fingerprint) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitJA4Fingerprint) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitJA4Fingerprint) 

# RateLimitLabelNamespace
<a name="API_RateLimitLabelNamespace"></a>

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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-label-requirements.html) in the * AWS WAF Developer Guide*.

## Contents
<a name="API_RateLimitLabelNamespace_Contents"></a>

 ** Namespace **   <a name="WAF-Type-RateLimitLabelNamespace-Namespace"></a>
The namespace to use for aggregation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+:$`   
Required: Yes

## See Also
<a name="API_RateLimitLabelNamespace_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitLabelNamespace) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitLabelNamespace) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitLabelNamespace) 

# RateLimitQueryArgument
<a name="API_RateLimitQueryArgument"></a>

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. 

## Contents
<a name="API_RateLimitQueryArgument_Contents"></a>

 ** Name **   <a name="WAF-Type-RateLimitQueryArgument-Name"></a>
The name of the query argument to use.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-RateLimitQueryArgument-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RateLimitQueryArgument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitQueryArgument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitQueryArgument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitQueryArgument) 

# RateLimitQueryString
<a name="API_RateLimitQueryString"></a>

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. 

## Contents
<a name="API_RateLimitQueryString_Contents"></a>

 ** TextTransformations **   <a name="WAF-Type-RateLimitQueryString-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RateLimitQueryString_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitQueryString) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitQueryString) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitQueryString) 

# RateLimitUriPath
<a name="API_RateLimitUriPath"></a>

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. 

## Contents
<a name="API_RateLimitUriPath_Contents"></a>

 ** TextTransformations **   <a name="WAF-Type-RateLimitUriPath-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RateLimitUriPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RateLimitUriPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RateLimitUriPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RateLimitUriPath) 

# Regex
<a name="API_Regex"></a>

A single regular expression. This is used in a [RegexPatternSet](API_RegexPatternSet.md) and also in the configuration for the AWS Managed Rules rule group `AWSManagedRulesAntiDDoSRuleSet`.

## Contents
<a name="API_Regex_Contents"></a>

 ** RegexString **   <a name="WAF-Type-Regex-RegexString"></a>
The string representing the regular expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*`   
Required: No

## See Also
<a name="API_Regex_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Regex) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Regex) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Regex) 

# RegexMatchStatement
<a name="API_RegexMatchStatement"></a>

A rule statement used to search web request components for a match against a single regular expression. 

## Contents
<a name="API_RegexMatchStatement_Contents"></a>

 ** FieldToMatch **   <a name="WAF-Type-RegexMatchStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** RegexString **   <a name="WAF-Type-RegexMatchStatement-RegexString"></a>
The string representing the regular expression.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*`   
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-RegexMatchStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RegexMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RegexMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RegexMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RegexMatchStatement) 

# RegexPatternSet
<a name="API_RegexPatternSet"></a>

Contains one or more regular expressions. 

 AWS WAF assigns an ARN to each `RegexPatternSet` that you create. To use a set in a rule, you provide the ARN to the [Rule](API_Rule.md) statement [RegexPatternSetReferenceStatement](API_RegexPatternSetReferenceStatement.md). 

## Contents
<a name="API_RegexPatternSet_Contents"></a>

 ** ARN **   <a name="WAF-Type-RegexPatternSet-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-RegexPatternSet-Description"></a>
A description of the set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-RegexPatternSet-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-RegexPatternSet-Name"></a>
The name of the set. You cannot change the name after you create the set.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** RegularExpressionList **   <a name="WAF-Type-RegexPatternSet-RegularExpressionList"></a>
The regular expression patterns in the set.  
Type: Array of [Regex](API_Regex.md) objects  
Required: No

## See Also
<a name="API_RegexPatternSet_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RegexPatternSet) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RegexPatternSet) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RegexPatternSet) 

# RegexPatternSetReferenceStatement
<a name="API_RegexPatternSetReferenceStatement"></a>

A rule statement used to search web request components for matches with regular expressions. To use this, create a [RegexPatternSet](API_RegexPatternSet.md) 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](API_CreateRegexPatternSet.md).

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, AWS WAF automatically updates all rules that reference it.

## Contents
<a name="API_RegexPatternSetReferenceStatement_Contents"></a>

 ** ARN **   <a name="WAF-Type-RegexPatternSetReferenceStatement-ARN"></a>
The Amazon Resource Name (ARN) of the [RegexPatternSet](API_RegexPatternSet.md) that this statement references.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** FieldToMatch **   <a name="WAF-Type-RegexPatternSetReferenceStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-RegexPatternSetReferenceStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_RegexPatternSetReferenceStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RegexPatternSetReferenceStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RegexPatternSetReferenceStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RegexPatternSetReferenceStatement) 

# RegexPatternSetSummary
<a name="API_RegexPatternSetSummary"></a>

High-level information about a [RegexPatternSet](API_RegexPatternSet.md), 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](API_RegexPatternSetReferenceStatement.md) to use the pattern set in a [Rule](API_Rule.md).

## Contents
<a name="API_RegexPatternSetSummary_Contents"></a>

 ** ARN **   <a name="WAF-Type-RegexPatternSetSummary-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-RegexPatternSetSummary-Description"></a>
A description of the set that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-RegexPatternSetSummary-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** LockToken **   <a name="WAF-Type-RegexPatternSetSummary-LockToken"></a>
A token used for optimistic locking. AWS WAF returns a token to your `get` and `list` 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 like `update` and `delete`. AWS 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 a `WAFOptimisticLockException`. If this happens, perform another `get`, and use the new token returned by that operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-RegexPatternSetSummary-Name"></a>
The name of the data type instance. You cannot change the name after you create the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_RegexPatternSetSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RegexPatternSetSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RegexPatternSetSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RegexPatternSetSummary) 

# ReleaseSummary
<a name="API_ReleaseSummary"></a>

High level information for an SDK release. 

## Contents
<a name="API_ReleaseSummary_Contents"></a>

 ** ReleaseVersion **   <a name="WAF-Type-ReleaseSummary-ReleaseVersion"></a>
The release version.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `^[\w#:\.\-/]+$`   
Required: No

 ** Timestamp **   <a name="WAF-Type-ReleaseSummary-Timestamp"></a>
The timestamp of the release.   
Type: Timestamp  
Required: No

## See Also
<a name="API_ReleaseSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ReleaseSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ReleaseSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ReleaseSummary) 

# RequestBodyAssociatedResourceTypeConfig
<a name="API_RequestBodyAssociatedResourceTypeConfig"></a>

Customizes the maximum size of the request body that your protected CloudFront, API Gateway, Amazon Cognito, App Runner, and Verified Access resources forward to AWS WAF for inspection. The default size is 16 KB (16,384 bytes). You can change the setting for any of the available resource types. 

**Note**  
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).

Example JSON: ` { "API_GATEWAY": "KB_48", "APP_RUNNER_SERVICE": "KB_32" }` 

For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).

This is used in the `AssociationConfig` of the web ACL. 

## Contents
<a name="API_RequestBodyAssociatedResourceTypeConfig_Contents"></a>

 ** DefaultSizeInspectionLimit **   <a name="WAF-Type-RequestBodyAssociatedResourceTypeConfig-DefaultSizeInspectionLimit"></a>
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 AWS WAF for inspection. This applies to statements in the web ACL that inspect the body or JSON body.   
Default: `16 KB (16,384 bytes)`   
Type: String  
Valid Values: `KB_16 | KB_32 | KB_48 | KB_64`   
Required: Yes

## See Also
<a name="API_RequestBodyAssociatedResourceTypeConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RequestBodyAssociatedResourceTypeConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RequestBodyAssociatedResourceTypeConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RequestBodyAssociatedResourceTypeConfig) 

# RequestInspection
<a name="API_RequestInspection"></a>

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. 

## Contents
<a name="API_RequestInspection_Contents"></a>

 ** PasswordField **   <a name="WAF-Type-RequestInspection-PasswordField"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `password1`.
Type: [PasswordField](API_PasswordField.md) object  
Required: Yes

 ** PayloadType **   <a name="WAF-Type-RequestInspection-PayloadType"></a>
The payload type for your login endpoint, either JSON or form encoded.  
Type: String  
Valid Values: `JSON | FORM_ENCODED`   
Required: Yes

 ** UsernameField **   <a name="WAF-Type-RequestInspection-UsernameField"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `username1` 
Type: [UsernameField](API_UsernameField.md) object  
Required: Yes

## See Also
<a name="API_RequestInspection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RequestInspection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RequestInspection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RequestInspection) 

# RequestInspectionACFP
<a name="API_RequestInspectionACFP"></a>

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. 

## Contents
<a name="API_RequestInspectionACFP_Contents"></a>

 ** PayloadType **   <a name="WAF-Type-RequestInspectionACFP-PayloadType"></a>
The payload type for your account creation endpoint, either JSON or form encoded.  
Type: String  
Valid Values: `JSON | FORM_ENCODED`   
Required: Yes

 ** AddressFields **   <a name="WAF-Type-RequestInspectionACFP-AddressFields"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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`, and `primaryaddressline3`, the address fields identifiers are `primaryaddressline1`, `primaryaddressline2`, and `primaryaddressline3`. 
Type: Array of [AddressField](API_AddressField.md) objects  
Required: No

 ** EmailField **   <a name="WAF-Type-RequestInspectionACFP-EmailField"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `email1`.
Type: [EmailField](API_EmailField.md) object  
Required: No

 ** PasswordField **   <a name="WAF-Type-RequestInspectionACFP-PasswordField"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `password1`.
Type: [PasswordField](API_PasswordField.md) object  
Required: No

 ** PhoneNumberFields **   <a name="WAF-Type-RequestInspectionACFP-PhoneNumberFields"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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`, and `primaryphoneline3`, the phone number field identifiers are `primaryphoneline1`, `primaryphoneline2`, and `primaryphoneline3`. 
Type: Array of [PhoneNumberField](API_PhoneNumberField.md) objects  
Required: No

 ** UsernameField **   <a name="WAF-Type-RequestInspectionACFP-UsernameField"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `username1` 
Type: [UsernameField](API_UsernameField.md) object  
Required: No

## See Also
<a name="API_RequestInspectionACFP_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RequestInspectionACFP) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RequestInspectionACFP) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RequestInspectionACFP) 

# ResponseInspection
<a name="API_ResponseInspection"></a>

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. 

**Note**  
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. 

## Contents
<a name="API_ResponseInspection_Contents"></a>

 ** BodyContains **   <a name="WAF-Type-ResponseInspection-BodyContains"></a>
Configures inspection of the response body for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response body.   
Type: [ResponseInspectionBodyContains](API_ResponseInspectionBodyContains.md) object  
Required: No

 ** Header **   <a name="WAF-Type-ResponseInspection-Header"></a>
Configures inspection of the response header for success and failure indicators.   
Type: [ResponseInspectionHeader](API_ResponseInspectionHeader.md) object  
Required: No

 ** Json **   <a name="WAF-Type-ResponseInspection-Json"></a>
Configures inspection of the response JSON for success and failure indicators. AWS WAF can inspect the first 65,536 bytes (64 KB) of the response JSON.   
Type: [ResponseInspectionJson](API_ResponseInspectionJson.md) object  
Required: No

 ** StatusCode **   <a name="WAF-Type-ResponseInspection-StatusCode"></a>
Configures inspection of the response status code for success and failure indicators.   
Type: [ResponseInspectionStatusCode](API_ResponseInspectionStatusCode.md) object  
Required: No

## See Also
<a name="API_ResponseInspection_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ResponseInspection) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ResponseInspection) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ResponseInspection) 

# ResponseInspectionBodyContains
<a name="API_ResponseInspectionBodyContains"></a>

Configures inspection of the response body. AWS 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`. 

**Note**  
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

## Contents
<a name="API_ResponseInspectionBodyContains_Contents"></a>

 ** FailureStrings **   <a name="WAF-Type-ResponseInspectionBodyContains-FailureStrings"></a>
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" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

 ** SuccessStrings **   <a name="WAF-Type-ResponseInspectionBodyContains-SuccessStrings"></a>
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!" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_ResponseInspectionBodyContains_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ResponseInspectionBodyContains) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ResponseInspectionBodyContains) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ResponseInspectionBodyContains) 

# ResponseInspectionHeader
<a name="API_ResponseInspectionHeader"></a>

Configures inspection of the response header. This is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`. 

**Note**  
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

## Contents
<a name="API_ResponseInspectionHeader_Contents"></a>

 ** FailureValues **   <a name="WAF-Type-ResponseInspectionHeader-FailureValues"></a>
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" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

 ** Name **   <a name="WAF-Type-ResponseInspectionHeader-Name"></a>
The name of the header to match against. The name must be an exact match, including case.  
JSON example: `"Name": [ "RequestResult" ]`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 200.  
Pattern: `.*\S.*`   
Required: Yes

 ** SuccessValues **   <a name="WAF-Type-ResponseInspectionHeader-SuccessValues"></a>
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" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 3 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_ResponseInspectionHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ResponseInspectionHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ResponseInspectionHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ResponseInspectionHeader) 

# ResponseInspectionJson
<a name="API_ResponseInspectionJson"></a>

Configures inspection of the response JSON. AWS 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`. 

**Note**  
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

## Contents
<a name="API_ResponseInspectionJson_Contents"></a>

 ** FailureValues **   <a name="WAF-Type-ResponseInspectionJson-FailureValues"></a>
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" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

 ** Identifier **   <a name="WAF-Type-ResponseInspectionJson-Identifier"></a>
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" ]`   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

 ** SuccessValues **   <a name="WAF-Type-ResponseInspectionJson-SuccessValues"></a>
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" ]`   
Type: Array of strings  
Array Members: Minimum number of 1 item. Maximum number of 5 items.  
Length Constraints: Minimum length of 1. Maximum length of 100.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_ResponseInspectionJson_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ResponseInspectionJson) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ResponseInspectionJson) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ResponseInspectionJson) 

# ResponseInspectionStatusCode
<a name="API_ResponseInspectionStatusCode"></a>

Configures inspection of the response status code. This is part of the `ResponseInspection` configuration for `AWSManagedRulesATPRuleSet` and `AWSManagedRulesACFPRuleSet`. 

**Note**  
Response inspection is available only in web ACLs that protect Amazon CloudFront distributions.

## Contents
<a name="API_ResponseInspectionStatusCode_Contents"></a>

 ** FailureCodes **   <a name="WAF-Type-ResponseInspectionStatusCode-FailureCodes"></a>
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 ]`   
Type: Array of integers  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Valid Range: Minimum value of 0. Maximum value of 999.  
Required: Yes

 ** SuccessCodes **   <a name="WAF-Type-ResponseInspectionStatusCode-SuccessCodes"></a>
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 ]`   
Type: Array of integers  
Array Members: Minimum number of 1 item. Maximum number of 10 items.  
Valid Range: Minimum value of 0. Maximum value of 999.  
Required: Yes

## See Also
<a name="API_ResponseInspectionStatusCode_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/ResponseInspectionStatusCode) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/ResponseInspectionStatusCode) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/ResponseInspectionStatusCode) 

# Rule
<a name="API_Rule"></a>

A single rule, which you can use in a [WebACL](API_WebACL.md) or [RuleGroup](API_RuleGroup.md) to identify web requests that you want to manage in some way. Each rule includes one top-level [Statement](API_Statement.md) that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them. 

## Contents
<a name="API_Rule_Contents"></a>

 ** Name **   <a name="WAF-Type-Rule-Name"></a>
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's `VisibilityConfig` settings. AWS WAF doesn't automatically update the metric name when you update the rule name.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** Priority **   <a name="WAF-Type-Rule-Priority"></a>
If you define more than one `Rule` in a `WebACL`, AWS WAF evaluates each request against the `Rules` in order based on the value of `Priority`. AWS WAF processes rules with lower priority first. The priorities don't need to be consecutive, but they must all be different.  
Type: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Statement **   <a name="WAF-Type-Rule-Statement"></a>
The AWS WAF processing statement for the rule, for example [ByteMatchStatement](API_ByteMatchStatement.md) or [SizeConstraintStatement](API_SizeConstraintStatement.md).   
Type: [Statement](API_Statement.md) object  
Required: Yes

 ** VisibilityConfig **   <a name="WAF-Type-Rule-VisibilityConfig"></a>
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. AWS WAF doesn't automatically update the metric name.   
Type: [VisibilityConfig](API_VisibilityConfig.md) object  
Required: Yes

 ** Action **   <a name="WAF-Type-Rule-Action"></a>
The action that AWS 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` and `ManagedRuleGroupStatement`.   
You must specify either this `Action` setting or the rule `OverrideAction` 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. 
Type: [RuleAction](API_RuleAction.md) object  
Required: No

 ** CaptchaConfig **   <a name="WAF-Type-Rule-CaptchaConfig"></a>
Specifies how AWS WAF should handle `CAPTCHA` evaluations. If you don't specify this, AWS WAF uses the `CAPTCHA` configuration that's defined for the web ACL.   
Type: [CaptchaConfig](API_CaptchaConfig.md) object  
Required: No

 ** ChallengeConfig **   <a name="WAF-Type-Rule-ChallengeConfig"></a>
Specifies how AWS WAF should handle `Challenge` evaluations. If you don't specify this, AWS WAF uses the challenge configuration that's defined for the web ACL.   
Type: [ChallengeConfig](API_ChallengeConfig.md) object  
Required: No

 ** OverrideAction **   <a name="WAF-Type-Rule-OverrideAction"></a>
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. 
Type: [OverrideAction](API_OverrideAction.md) object  
Required: No

 ** RuleLabels **   <a name="WAF-Type-Rule-RuleLabels"></a>
Labels to apply to web requests that match the rule match statement. AWS 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.   
Any rule that isn't a rule group reference statement or managed rule group statement can add labels to matching web requests.
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`, or `ipset`.
For example, `myLabelName` or `nameSpace1:nameSpace2:myLabelName`.   
Type: Array of [Label](API_Label.md) objects  
Required: No

## See Also
<a name="API_Rule_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Rule) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Rule) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Rule) 

# RuleAction
<a name="API_RuleAction"></a>

The action that AWS 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. 

## Contents
<a name="API_RuleAction_Contents"></a>

 ** Allow **   <a name="WAF-Type-RuleAction-Allow"></a>
Instructs AWS WAF to allow the web request.  
Type: [AllowAction](API_AllowAction.md) object  
Required: No

 ** Block **   <a name="WAF-Type-RuleAction-Block"></a>
Instructs AWS WAF to block the web request.  
Type: [BlockAction](API_BlockAction.md) object  
Required: No

 ** Captcha **   <a name="WAF-Type-RuleAction-Captcha"></a>
Instructs AWS WAF to run a `CAPTCHA` check against the web request.  
Type: [CaptchaAction](API_CaptchaAction.md) object  
Required: No

 ** Challenge **   <a name="WAF-Type-RuleAction-Challenge"></a>
Instructs AWS WAF to run a `Challenge` check against the web request.  
Type: [ChallengeAction](API_ChallengeAction.md) object  
Required: No

 ** Count **   <a name="WAF-Type-RuleAction-Count"></a>
Instructs AWS WAF to count the web request and then continue evaluating the request using the remaining rules in the web ACL.  
Type: [CountAction](API_CountAction.md) object  
Required: No

## See Also
<a name="API_RuleAction_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleAction) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleAction) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleAction) 

# RuleActionOverride
<a name="API_RuleActionOverride"></a>

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. 

**Note**  
Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.

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.

## Contents
<a name="API_RuleActionOverride_Contents"></a>

 ** ActionToUse **   <a name="WAF-Type-RuleActionOverride-ActionToUse"></a>
The override action to use, in place of the configured action of the rule in the rule group.   
Type: [RuleAction](API_RuleAction.md) object  
Required: Yes

 ** Name **   <a name="WAF-Type-RuleActionOverride-Name"></a>
The name of the rule to override.  
Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

## See Also
<a name="API_RuleActionOverride_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleActionOverride) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleActionOverride) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleActionOverride) 

# RuleGroup
<a name="API_RuleGroup"></a>

 A rule group defines a collection of rules to inspect and control web requests that you can use in a [WebACL](API_WebACL.md). 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. 

## Contents
<a name="API_RuleGroup_Contents"></a>

 ** ARN **   <a name="WAF-Type-RuleGroup-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** Capacity **   <a name="WAF-Type-RuleGroup-Capacity"></a>
The web ACL capacity units (WCUs) required for this rule group.  
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using [CheckCapacity](API_CheckCapacity.md).  
 AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [AWS WAF web ACL capacity units (WCU)](https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) in the * AWS WAF Developer Guide*.   
Type: Long  
Valid Range: Minimum value of 1.  
Required: Yes

 ** Id **   <a name="WAF-Type-RuleGroup-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: Yes

 ** Name **   <a name="WAF-Type-RuleGroup-Name"></a>
The name of the rule group. You cannot change the name of a rule group after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** VisibilityConfig **   <a name="WAF-Type-RuleGroup-VisibilityConfig"></a>
Defines and enables Amazon CloudWatch metrics and web request sample collection.   
Type: [VisibilityConfig](API_VisibilityConfig.md) object  
Required: Yes

 ** AvailableLabels **   <a name="WAF-Type-RuleGroup-AvailableLabels"></a>
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](API_Rule.md).  
Type: Array of [LabelSummary](API_LabelSummary.md) objects  
Required: No

 ** ConsumedLabels **   <a name="WAF-Type-RuleGroup-ConsumedLabels"></a>
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](API_Statement.md) definition of a rule.   
Type: Array of [LabelSummary](API_LabelSummary.md) objects  
Required: No

 ** CustomResponseBodies **   <a name="WAF-Type-RuleGroup-CustomResponseBodies"></a>
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.   
For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the * AWS WAF Developer Guide*.   
Type: String to [CustomResponseBody](API_CustomResponseBody.md) object map  
Map Entries: Maximum number of items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^[\w\-]+$`   
Required: No

 ** Description **   <a name="WAF-Type-RuleGroup-Description"></a>
A description of the rule group that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** LabelNamespace **   <a name="WAF-Type-RuleGroup-LabelNamespace"></a>
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, AWS 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>` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: No

 ** Rules **   <a name="WAF-Type-RuleGroup-Rules"></a>
The [Rule](API_Rule.md) statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.   
Type: Array of [Rule](API_Rule.md) objects  
Required: No

## See Also
<a name="API_RuleGroup_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleGroup) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleGroup) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleGroup) 

# RuleGroupReferenceStatement
<a name="API_RuleGroupReferenceStatement"></a>

A rule statement used to run the rules that are defined in a [RuleGroup](API_RuleGroup.md). 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.

## Contents
<a name="API_RuleGroupReferenceStatement_Contents"></a>

 ** ARN **   <a name="WAF-Type-RuleGroupReferenceStatement-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** ExcludedRules **   <a name="WAF-Type-RuleGroupReferenceStatement-ExcludedRules"></a>
Rules in the referenced rule group whose actions are set to `Count`.   
Instead of this option, use `RuleActionOverrides`. It accepts any valid action setting, including `Count`.
Type: Array of [ExcludedRule](API_ExcludedRule.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

 ** RuleActionOverrides **   <a name="WAF-Type-RuleGroupReferenceStatement-RuleActionOverrides"></a>
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.   
Verify the rule names in your overrides carefully. With managed rule groups, AWS WAF silently ignores any override that uses an invalid rule name. With customer-owned rule groups, invalid rule names in your overrides will cause web ACL updates to fail. An invalid rule name is any name that doesn't exactly match the case-sensitive name of an existing rule in the rule group.
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.  
Type: Array of [RuleActionOverride](API_RuleActionOverride.md) objects  
Array Members: Maximum number of 100 items.  
Required: No

## See Also
<a name="API_RuleGroupReferenceStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleGroupReferenceStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleGroupReferenceStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleGroupReferenceStatement) 

# RuleGroupSummary
<a name="API_RuleGroupSummary"></a>

High-level information about a [RuleGroup](API_RuleGroup.md), 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](API_RuleGroupReferenceStatement.md) to use the rule group in a [Rule](API_Rule.md).

## Contents
<a name="API_RuleGroupSummary_Contents"></a>

 ** ARN **   <a name="WAF-Type-RuleGroupSummary-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-RuleGroupSummary-Description"></a>
A description of the rule group that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-RuleGroupSummary-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** LockToken **   <a name="WAF-Type-RuleGroupSummary-LockToken"></a>
A token used for optimistic locking. AWS WAF returns a token to your `get` and `list` 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 like `update` and `delete`. AWS 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 a `WAFOptimisticLockException`. If this happens, perform another `get`, and use the new token returned by that operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-RuleGroupSummary-Name"></a>
The name of the data type instance. You cannot change the name after you create the instance.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_RuleGroupSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleGroupSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleGroupSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleGroupSummary) 

# RuleSummary
<a name="API_RuleSummary"></a>

High-level information about a [Rule](API_Rule.md), returned by operations like [DescribeManagedRuleGroup](API_DescribeManagedRuleGroup.md). 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](API_RuleGroupReferenceStatement.md) to use the rule group in a [Rule](API_Rule.md).

## Contents
<a name="API_RuleSummary_Contents"></a>

 ** Action **   <a name="WAF-Type-RuleSummary-Action"></a>
The action that AWS 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.   
Type: [RuleAction](API_RuleAction.md) object  
Required: No

 ** Name **   <a name="WAF-Type-RuleSummary-Name"></a>
The name of the rule.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_RuleSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/RuleSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/RuleSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/RuleSummary) 

# SampledHTTPRequest
<a name="API_SampledHTTPRequest"></a>

Represents a single sampled web request. The response from [GetSampledRequests](API_GetSampledRequests.md) includes a `SampledHTTPRequests` complex type that appears as `SampledRequests` in the response syntax. `SampledHTTPRequests` contains an array of `SampledHTTPRequest` objects.

## Contents
<a name="API_SampledHTTPRequest_Contents"></a>

 ** Request **   <a name="WAF-Type-SampledHTTPRequest-Request"></a>
A complex type that contains detailed information about the request.  
Type: [HTTPRequest](API_HTTPRequest.md) object  
Required: Yes

 ** Weight **   <a name="WAF-Type-SampledHTTPRequest-Weight"></a>
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 of `1`.  
Type: Long  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Action **   <a name="WAF-Type-SampledHTTPRequest-Action"></a>
The action that AWS WAF applied to the request.  
Type: String  
Required: No

 ** CaptchaResponse **   <a name="WAF-Type-SampledHTTPRequest-CaptchaResponse"></a>
The `CAPTCHA` response for the request.  
Type: [CaptchaResponse](API_CaptchaResponse.md) object  
Required: No

 ** ChallengeResponse **   <a name="WAF-Type-SampledHTTPRequest-ChallengeResponse"></a>
The `Challenge` response for the request.  
Type: [ChallengeResponse](API_ChallengeResponse.md) object  
Required: No

 ** Labels **   <a name="WAF-Type-SampledHTTPRequest-Labels"></a>
Labels applied to the web request by matching rules. AWS 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` or `awswaf:managed:aws:managed-rule-set:header:encoding:utf8`.   
Type: Array of [Label](API_Label.md) objects  
Required: No

 ** OverriddenAction **   <a name="WAF-Type-SampledHTTPRequest-OverriddenAction"></a>
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 AWS WAF applied is the `Action` value.   
Type: String  
Required: No

 ** RequestHeadersInserted **   <a name="WAF-Type-SampledHTTPRequest-RequestHeadersInserted"></a>
Custom request headers inserted by AWS WAF into the request, according to the custom request configuration for the matching rule action.  
Type: Array of [HTTPHeader](API_HTTPHeader.md) objects  
Required: No

 ** ResponseCodeSent **   <a name="WAF-Type-SampledHTTPRequest-ResponseCodeSent"></a>
The response code that was sent for the request.  
Type: Integer  
Valid Range: Minimum value of 200. Maximum value of 599.  
Required: No

 ** RuleNameWithinRuleGroup **   <a name="WAF-Type-SampledHTTPRequest-RuleNameWithinRuleGroup"></a>
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.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

 ** Timestamp **   <a name="WAF-Type-SampledHTTPRequest-Timestamp"></a>
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).  
Type: Timestamp  
Required: No

## See Also
<a name="API_SampledHTTPRequest_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/SampledHTTPRequest) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/SampledHTTPRequest) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/SampledHTTPRequest) 

# SingleHeader
<a name="API_SingleHeader"></a>

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](API_FieldToMatch.md) specification. 

Example JSON: `"SingleHeader": { "Name": "haystack" }` 

## Contents
<a name="API_SingleHeader_Contents"></a>

 ** Name **   <a name="WAF-Type-SingleHeader-Name"></a>
The name of the query header to inspect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_SingleHeader_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/SingleHeader) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/SingleHeader) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/SingleHeader) 

# SingleQueryArgument
<a name="API_SingleQueryArgument"></a>

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](API_FieldToMatch.md) specification. 

Example JSON: `"SingleQueryArgument": { "Name": "myArgument" }` 

## Contents
<a name="API_SingleQueryArgument_Contents"></a>

 ** Name **   <a name="WAF-Type-SingleQueryArgument-Name"></a>
The name of the query argument to inspect.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 64.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_SingleQueryArgument_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/SingleQueryArgument) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/SingleQueryArgument) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/SingleQueryArgument) 

# SizeConstraintStatement
<a name="API_SizeConstraintStatement"></a>

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 AWS WAF to inspect the request body, AWS 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.

## Contents
<a name="API_SizeConstraintStatement_Contents"></a>

 ** ComparisonOperator **   <a name="WAF-Type-SizeConstraintStatement-ComparisonOperator"></a>
The operator to use to compare the request part to the size setting.   
Type: String  
Valid Values: `EQ | NE | LE | LT | GE | GT`   
Required: Yes

 ** FieldToMatch **   <a name="WAF-Type-SizeConstraintStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** Size **   <a name="WAF-Type-SizeConstraintStatement-Size"></a>
The size, in byte, to compare to the request part, after any transformations.  
Type: Long  
Valid Range: Minimum value of 0. Maximum value of 21474836480.  
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-SizeConstraintStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_SizeConstraintStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/SizeConstraintStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/SizeConstraintStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/SizeConstraintStatement) 

# SqliMatchStatement
<a name="API_SqliMatchStatement"></a>

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. 

## Contents
<a name="API_SqliMatchStatement_Contents"></a>

 ** FieldToMatch **   <a name="WAF-Type-SqliMatchStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-SqliMatchStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

 ** SensitivityLevel **   <a name="WAF-Type-SqliMatchStatement-SensitivityLevel"></a>
The sensitivity that you want AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-testing.html) in the * AWS 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`   
Type: String  
Valid Values: `LOW | HIGH`   
Required: No

## See Also
<a name="API_SqliMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/SqliMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/SqliMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/SqliMatchStatement) 

# Statement
<a name="API_Statement"></a>

The processing guidance for a [Rule](API_Rule.md), used by AWS WAF to determine whether a web request matches the rule. 

For example specifications, see the examples section of [CreateWebACL](API_CreateWebACL.md).

## Contents
<a name="API_Statement_Contents"></a>

 ** AndStatement **   <a name="WAF-Type-Statement-AndStatement"></a>
A logical rule statement used to combine other rule statements with AND logic. You provide more than one [Statement](#API_Statement) within the `AndStatement`.   
Type: [AndStatement](API_AndStatement.md) object  
Required: No

 ** AsnMatchStatement **   <a name="WAF-Type-Statement-AsnMatchStatement"></a>
A rule statement that inspects web traffic based on the Autonomous System Number (ASN) associated with the request's IP address.  
For additional details, see [ASN match rule statement](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-asn-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).   
Type: [AsnMatchStatement](API_AsnMatchStatement.md) object  
Required: No

 ** ByteMatchStatement **   <a name="WAF-Type-Statement-ByteMatchStatement"></a>
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is called a string match statement.  
Type: [ByteMatchStatement](API_ByteMatchStatement.md) object  
Required: No

 ** GeoMatchStatement **   <a name="WAF-Type-Statement-GeoMatchStatement"></a>
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. 
 AWS WAF labels requests using the alpha-2 country and region codes from the International Organization for Standardization (ISO) 3166 standard. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-type-geo-match.html) in the [AWS WAF Developer Guide](https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html).   
Type: [GeoMatchStatement](API_GeoMatchStatement.md) object  
Required: No

 ** IPSetReferenceStatement **   <a name="WAF-Type-Statement-IPSetReferenceStatement"></a>
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an [IPSet](API_IPSet.md) 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](API_CreateIPSet.md).  
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, AWS WAF automatically updates all rules that reference it.  
Type: [IPSetReferenceStatement](API_IPSetReferenceStatement.md) object  
Required: No

 ** LabelMatchStatement **   <a name="WAF-Type-Statement-LabelMatchStatement"></a>
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, AWS WAF performs the search for labels that were added in the same context as the label match statement.   
Type: [LabelMatchStatement](API_LabelMatchStatement.md) object  
Required: No

 ** ManagedRuleGroupStatement **   <a name="WAF-Type-Statement-ManagedRuleGroupStatement"></a>
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](API_ListAvailableManagedRuleGroups.md).  
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 AWS WAF Bot Control managed rule group `AWSManagedRulesBotControlRuleSet`, the AWS WAF Fraud Control account takeover prevention (ATP) managed rule group `AWSManagedRulesATPRuleSet`, or the AWS WAF Fraud Control account creation fraud prevention (ACFP) managed rule group `AWSManagedRulesACFPRuleSet`. For more information, see [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).
Type: [ManagedRuleGroupStatement](API_ManagedRuleGroupStatement.md) object  
Required: No

 ** NotStatement **   <a name="WAF-Type-Statement-NotStatement"></a>
A logical rule statement used to negate the results of another rule statement. You provide one [Statement](#API_Statement) within the `NotStatement`.  
Type: [NotStatement](API_NotStatement.md) object  
Required: No

 ** OrStatement **   <a name="WAF-Type-Statement-OrStatement"></a>
A logical rule statement used to combine other rule statements with OR logic. You provide more than one [Statement](#API_Statement) within the `OrStatement`.   
Type: [OrStatement](API_OrStatement.md) object  
Required: No

 ** RateBasedStatement **   <a name="WAF-Type-Statement-RateBasedStatement"></a>
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 AWS 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 AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rate-based-rules.html) in the * AWS 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 AWS WAF is currently rate limiting for a rule through the API call `GetRateBasedStatementManagedKeys`. This option is not available for other aggregation configurations.  
 AWS 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 AWS 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 AWS WAF.   
Type: [RateBasedStatement](API_RateBasedStatement.md) object  
Required: No

 ** RegexMatchStatement **   <a name="WAF-Type-Statement-RegexMatchStatement"></a>
A rule statement used to search web request components for a match against a single regular expression.   
Type: [RegexMatchStatement](API_RegexMatchStatement.md) object  
Required: No

 ** RegexPatternSetReferenceStatement **   <a name="WAF-Type-Statement-RegexPatternSetReferenceStatement"></a>
A rule statement used to search web request components for matches with regular expressions. To use this, create a [RegexPatternSet](API_RegexPatternSet.md) 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](API_CreateRegexPatternSet.md).  
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, AWS WAF automatically updates all rules that reference it.  
Type: [RegexPatternSetReferenceStatement](API_RegexPatternSetReferenceStatement.md) object  
Required: No

 ** RuleGroupReferenceStatement **   <a name="WAF-Type-Statement-RuleGroupReferenceStatement"></a>
A rule statement used to run the rules that are defined in a [RuleGroup](API_RuleGroup.md). 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.  
Type: [RuleGroupReferenceStatement](API_RuleGroupReferenceStatement.md) object  
Required: No

 ** SizeConstraintStatement **   <a name="WAF-Type-Statement-SizeConstraintStatement"></a>
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 AWS WAF to inspect the request body, AWS 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.  
Type: [SizeConstraintStatement](API_SizeConstraintStatement.md) object  
Required: No

 ** SqliMatchStatement **   <a name="WAF-Type-Statement-SqliMatchStatement"></a>
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.   
Type: [SqliMatchStatement](API_SqliMatchStatement.md) object  
Required: No

 ** XssMatchStatement **   <a name="WAF-Type-Statement-XssMatchStatement"></a>
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.   
Type: [XssMatchStatement](API_XssMatchStatement.md) object  
Required: No

## See Also
<a name="API_Statement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Statement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Statement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Statement) 

# Tag
<a name="API_Tag"></a>

A tag associated with an AWS 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 AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. 

## Contents
<a name="API_Tag_Contents"></a>

 ** Key **   <a name="WAF-Type-Tag-Key"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

 ** Value **   <a name="WAF-Type-Tag-Value"></a>
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.  
Type: String  
Length Constraints: Minimum length of 0. Maximum length of 256.  
Pattern: `^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$`   
Required: Yes

## See Also
<a name="API_Tag_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/Tag) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/Tag) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/Tag) 

# TagInfoForResource
<a name="API_TagInfoForResource"></a>

The collection of tagging definitions for an AWS 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 AWS resource, up to 50 tags for a resource.

You can tag the AWS resources that you manage through AWS WAF: web ACLs, rule groups, IP sets, and regex pattern sets. You can't manage or view tags through the AWS WAF console. 

## Contents
<a name="API_TagInfoForResource_Contents"></a>

 ** ResourceARN **   <a name="WAF-Type-TagInfoForResource-ResourceARN"></a>
The Amazon Resource Name (ARN) of the resource.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** TagList **   <a name="WAF-Type-TagInfoForResource-TagList"></a>
The array of [Tag](API_Tag.md) objects defined for the resource.   
Type: Array of [Tag](API_Tag.md) objects  
Array Members: Minimum number of 1 item.  
Required: No

## See Also
<a name="API_TagInfoForResource_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/TagInfoForResource) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/TagInfoForResource) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/TagInfoForResource) 

# TextTransformation
<a name="API_TextTransformation"></a>

Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. 

## Contents
<a name="API_TextTransformation_Contents"></a>

 ** Priority **   <a name="WAF-Type-TextTransformation-Priority"></a>
Sets the relative processing order for multiple transformations. AWS 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: Integer  
Valid Range: Minimum value of 0.  
Required: Yes

 ** Type **   <a name="WAF-Type-TextTransformation-Type"></a>
For detailed descriptions of each of the transformation types, see [Text transformations](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-transformation.html) in the * AWS WAF Developer Guide*.  
Type: String  
Valid Values: `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: Yes

## See Also
<a name="API_TextTransformation_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/TextTransformation) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/TextTransformation) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/TextTransformation) 

# TimeWindow
<a name="API_TimeWindow"></a>

In a [GetSampledRequests](API_GetSampledRequests.md) request, the `StartTime` and `EndTime` objects specify the time range for which you want AWS 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](API_GetSampledRequests.md) response, the `StartTime` and `EndTime` objects specify the time range for which AWS WAF actually returned a sample of web requests. AWS WAF gets the specified number of requests from among the first 5,000 requests that your AWS resource receives during the specified time period. If your resource receives more than 5,000 requests during that period, AWS WAF stops sampling after the 5,000th request. In that case, `EndTime` is the time that AWS WAF received the 5,000th request.

## Contents
<a name="API_TimeWindow_Contents"></a>

 ** EndTime **   <a name="WAF-Type-TimeWindow-EndTime"></a>
The end of the time range from which you want `GetSampledRequests` to return a sample of the requests that your AWS 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.  
Type: Timestamp  
Required: Yes

 ** StartTime **   <a name="WAF-Type-TimeWindow-StartTime"></a>
The beginning of the time range from which you want `GetSampledRequests` to return a sample of the requests that your AWS 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.  
Type: Timestamp  
Required: Yes

## See Also
<a name="API_TimeWindow_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/TimeWindow) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/TimeWindow) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/TimeWindow) 

# UriFragment
<a name="API_UriFragment"></a>

Inspect fragments of the request URI. You can specify the parts of the URI fragment to inspect and you can narrow the set of URI fragments to inspect by including or excluding specific keys. 

This is used to indicate the web request component to inspect, in the [FieldToMatch](API_FieldToMatch.md) specification. 

Example JSON: `"UriFragment": { "MatchPattern": { "All": {} }, "MatchScope": "KEY", "OversizeHandling": "MATCH" }` 

## Contents
<a name="API_UriFragment_Contents"></a>

 ** FallbackBehavior **   <a name="WAF-Type-UriFragment-FallbackBehavior"></a>
What AWS 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. AWS 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. AWS 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, AWS WAF parses and evaluates the content only up to the first parsing failure that it encounters.   
Example JSON: `{ "UriFragment": { "FallbackBehavior": "MATCH"} }`   
 AWS WAF parsing doesn't fully validate the input JSON string, so parsing can succeed even for invalid JSON. When parsing succeeds, AWS WAF doesn't apply the fallback behavior. For more information, see [JSON body](https://docs.aws.amazon.com/waf/latest/developerguide/waf-rule-statement-fields-list.html#waf-rule-statement-request-component-json-body) in the * AWS WAF Developer Guide*.
Type: String  
Valid Values: `MATCH | NO_MATCH`   
Required: No

## See Also
<a name="API_UriFragment_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/UriFragment) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/UriFragment) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/UriFragment) 

# UriPath
<a name="API_UriPath"></a>

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](API_FieldToMatch.md) specification for some web request component types. 

JSON specification: `"UriPath": {}` 

## Contents
<a name="API_UriPath_Contents"></a>

The members of this exception structure are context-dependent.

## See Also
<a name="API_UriPath_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/UriPath) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/UriPath) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/UriPath) 

# UsernameField
<a name="API_UsernameField"></a>

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. 

## Contents
<a name="API_UsernameField_Contents"></a>

 ** Identifier **   <a name="WAF-Type-UsernameField-Identifier"></a>
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](https://tools.ietf.org/html/rfc6901). 

  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 is `username1` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 512.  
Pattern: `.*\S.*`   
Required: Yes

## See Also
<a name="API_UsernameField_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/UsernameField) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/UsernameField) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/UsernameField) 

# VersionToPublish
<a name="API_VersionToPublish"></a>

A version of the named managed rule group, that the rule group's vendor publishes for use by customers. 

**Note**  
This is intended for use only by vendors of managed rule sets. Vendors are AWS and AWS 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`.

## Contents
<a name="API_VersionToPublish_Contents"></a>

 ** AssociatedRuleGroupArn **   <a name="WAF-Type-VersionToPublish-AssociatedRuleGroupArn"></a>
The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version.   
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** ForecastedLifetime **   <a name="WAF-Type-VersionToPublish-ForecastedLifetime"></a>
The amount of time the vendor expects this version of the managed rule group to last, in days.   
Type: Integer  
Valid Range: Minimum value of 1.  
Required: No

## See Also
<a name="API_VersionToPublish_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/VersionToPublish) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/VersionToPublish) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/VersionToPublish) 

# VisibilityConfig
<a name="API_VisibilityConfig"></a>

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

## Contents
<a name="API_VisibilityConfig_Contents"></a>

 ** CloudWatchMetricsEnabled **   <a name="WAF-Type-VisibilityConfig-CloudWatchMetricsEnabled"></a>
Indicates whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see [AWS WAF Metrics](https://docs.aws.amazon.com/waf/latest/developerguide/monitoring-cloudwatch.html#waf-metrics) in the * AWS WAF Developer Guide*.  
For web ACLs, the metrics are for web requests that have the web ACL default action applied. AWS 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](https://docs.aws.amazon.com/waf/latest/developerguide/web-acl-default-action.html) in the * AWS WAF Developer Guide*.  
Type: Boolean  
Required: Yes

 ** MetricName **   <a name="WAF-Type-VisibilityConfig-MetricName"></a>
A name of the Amazon CloudWatch metric dimension. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and \$1 (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names that are reserved for AWS WAF, for example `All` and `Default_Action`.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 255.  
Pattern: `^[\w#:\.\-/]+$`   
Required: Yes

 ** SampledRequestsEnabled **   <a name="WAF-Type-VisibilityConfig-SampledRequestsEnabled"></a>
Indicates whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.   
If you configure data protection for the web ACL, the protection applies to the web ACL's sampled web request data.   
Request sampling doesn't provide a field redaction option, and any field redaction that you specify in your logging configuration doesn't affect sampling. You can only exclude fields from request sampling by disabling sampling in the web ACL visibility configuration or by configuring data protection for the web ACL.
Type: Boolean  
Required: Yes

## See Also
<a name="API_VisibilityConfig_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/VisibilityConfig) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/VisibilityConfig) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/VisibilityConfig) 

# WebACL
<a name="API_WebACL"></a>

 A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has a statement that defines what to look for in web requests and an action that AWS WAF applies to requests that match the statement. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types [Rule](API_Rule.md), [RuleGroup](API_RuleGroup.md), and managed rule group. You can associate a web ACL with one or more AWS resources to protect. The resource types include Amazon CloudFront distribution, Amazon API Gateway REST API, Application Load Balancer, AWS AppSync GraphQL API, Amazon Cognito user pool, AWS App Runner service, AWS Amplify application, and AWS Verified Access instance. 

## Contents
<a name="API_WebACL_Contents"></a>

 ** ARN **   <a name="WAF-Type-WebACL-ARN"></a>
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: Yes

 ** DefaultAction **   <a name="WAF-Type-WebACL-DefaultAction"></a>
The action to perform if none of the `Rules` contained in the `WebACL` match.   
Type: [DefaultAction](API_DefaultAction.md) object  
Required: Yes

 ** Id **   <a name="WAF-Type-WebACL-Id"></a>
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 a `WebACL`.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: Yes

 ** Name **   <a name="WAF-Type-WebACL-Name"></a>
The name of the web ACL. You cannot change the name of a web ACL after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: Yes

 ** VisibilityConfig **   <a name="WAF-Type-WebACL-VisibilityConfig"></a>
Defines and enables Amazon CloudWatch metrics and web request sample collection.   
Type: [VisibilityConfig](API_VisibilityConfig.md) object  
Required: Yes

 ** ApplicationConfig **   <a name="WAF-Type-WebACL-ApplicationConfig"></a>
Returns a list of `ApplicationAttribute`s.  
Type: [ApplicationConfig](API_ApplicationConfig.md) object  
Required: No

 ** AssociationConfig **   <a name="WAF-Type-WebACL-AssociationConfig"></a>
Specifies custom configurations for the associations between the web ACL and protected resources.   
Use this to customize the maximum size of the request body that your protected resources forward to AWS WAF for inspection. You can customize this setting for CloudFront, API Gateway, Amazon Cognito, App Runner, or Verified Access resources. The default setting is 16 KB (16,384 bytes).   
You are charged additional fees when your protected resources forward body sizes that are larger than the default. For more information, see [AWS WAF Pricing](http://aws.amazon.com/waf/pricing/).
For Application Load Balancer and AWS AppSync, the limit is fixed at 8 KB (8,192 bytes).  
Type: [AssociationConfig](API_AssociationConfig.md) object  
Required: No

 ** Capacity **   <a name="WAF-Type-WebACL-Capacity"></a>
The web ACL capacity units (WCUs) currently being used by this web ACL.   
 AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [AWS WAF web ACL capacity units (WCU)](https://docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html) in the * AWS WAF Developer Guide*.   
Type: Long  
Valid Range: Minimum value of 0.  
Required: No

 ** CaptchaConfig **   <a name="WAF-Type-WebACL-CaptchaConfig"></a>
Specifies how AWS WAF should handle `CAPTCHA` evaluations for rules that don't have their own `CaptchaConfig` settings. If you don't specify this, AWS WAF uses its default settings for `CaptchaConfig`.   
Type: [CaptchaConfig](API_CaptchaConfig.md) object  
Required: No

 ** ChallengeConfig **   <a name="WAF-Type-WebACL-ChallengeConfig"></a>
Specifies how AWS WAF should handle challenge evaluations for rules that don't have their own `ChallengeConfig` settings. If you don't specify this, AWS WAF uses its default settings for `ChallengeConfig`.   
Type: [ChallengeConfig](API_ChallengeConfig.md) object  
Required: No

 ** CustomResponseBodies **   <a name="WAF-Type-WebACL-CustomResponseBodies"></a>
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.   
For information about customizing web requests and responses, see [Customizing web requests and responses in AWS WAF](https://docs.aws.amazon.com/waf/latest/developerguide/waf-custom-request-response.html) in the * AWS WAF Developer Guide*.   
For information about the limits on count and size for custom request and response settings, see [AWS WAF quotas](https://docs.aws.amazon.com/waf/latest/developerguide/limits.html) in the * AWS WAF Developer Guide*.   
Type: String to [CustomResponseBody](API_CustomResponseBody.md) object map  
Map Entries: Maximum number of items.  
Key Length Constraints: Minimum length of 1. Maximum length of 128.  
Key Pattern: `^[\w\-]+$`   
Required: No

 ** DataProtectionConfig **   <a name="WAF-Type-WebACL-DataProtectionConfig"></a>
Specifies data protection to apply to the web request data for the web ACL. This is a web ACL level data protection option.   
The data protection that you configure for the web ACL alters the data that's available for any other data collection activity, including your AWS WAF logging destinations, web ACL request sampling, and Amazon Security Lake data collection and management. Your other option for data protection is in the logging configuration, which only affects logging.   
Type: [DataProtectionConfig](API_DataProtectionConfig.md) object  
Required: No

 ** Description **   <a name="WAF-Type-WebACL-Description"></a>
A description of the web ACL that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** LabelNamespace **   <a name="WAF-Type-WebACL-LabelNamespace"></a>
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, AWS 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>` 
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 1024.  
Pattern: `^[0-9A-Za-z_\-:]+$`   
Required: No

 ** ManagedByFirewallManager **   <a name="WAF-Type-WebACL-ManagedByFirewallManager"></a>
Indicates whether this web ACL was created by AWS 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`, and `PostProcessFirewallManagerRuleGroups`.   
Type: Boolean  
Required: No

 ** OnSourceDDoSProtectionConfig **   <a name="WAF-Type-WebACL-OnSourceDDoSProtectionConfig"></a>
Configures the level of DDoS protection that applies to web ACLs associated with Application Load Balancers.  
Type: [OnSourceDDoSProtectionConfig](API_OnSourceDDoSProtectionConfig.md) object  
Required: No

 ** PostProcessFirewallManagerRuleGroups **   <a name="WAF-Type-WebACL-PostProcessFirewallManagerRuleGroups"></a>
The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager AWS 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 AWS 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.  
Type: Array of [FirewallManagerRuleGroup](API_FirewallManagerRuleGroup.md) objects  
Required: No

 ** PreProcessFirewallManagerRuleGroups **   <a name="WAF-Type-WebACL-PreProcessFirewallManagerRuleGroups"></a>
The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager AWS 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 AWS 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.  
Type: Array of [FirewallManagerRuleGroup](API_FirewallManagerRuleGroup.md) objects  
Required: No

 ** RetrofittedByFirewallManager **   <a name="WAF-Type-WebACL-RetrofittedByFirewallManager"></a>
Indicates whether this web ACL was created by a customer account and then retrofitted by AWS Firewall Manager. If true, then the web ACL is currently being managed by a Firewall Manager AWS WAF policy, and only Firewall Manager can manage any Firewall Manager rule groups in the web ACL. See also the properties `ManagedByFirewallManager`, `PreProcessFirewallManagerRuleGroups`, and `PostProcessFirewallManagerRuleGroups`.   
Type: Boolean  
Required: No

 ** Rules **   <a name="WAF-Type-WebACL-Rules"></a>
The [Rule](API_Rule.md) statements used to identify the web requests that you want to manage. Each rule includes one top-level statement that AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.   
Type: Array of [Rule](API_Rule.md) objects  
Required: No

 ** TokenDomains **   <a name="WAF-Type-WebACL-TokenDomains"></a>
Specifies the domains that AWS WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When AWS WAF provides a token, it uses the domain of the AWS resource that the web ACL is protecting. If you don't specify a list of token domains, AWS WAF accepts tokens only for the domain of the protected resource. With a token domain list, AWS WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.  
Type: Array of strings  
Length Constraints: Minimum length of 1. Maximum length of 253.  
Pattern: `^[\w\.\-/]+$`   
Required: No

## See Also
<a name="API_WebACL_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/WebACL) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/WebACL) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/WebACL) 

# WebACLSummary
<a name="API_WebACLSummary"></a>

High-level information about a [WebACL](API_WebACL.md), 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](API_AssociateWebACL.md).

## Contents
<a name="API_WebACLSummary_Contents"></a>

 ** ARN **   <a name="WAF-Type-WebACLSummary-ARN"></a>
The Amazon Resource Name (ARN) of the entity.  
Type: String  
Length Constraints: Minimum length of 20. Maximum length of 2048.  
Pattern: `.*\S.*`   
Required: No

 ** Description **   <a name="WAF-Type-WebACLSummary-Description"></a>
A description of the web ACL that helps with identification.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 256.  
Pattern: `^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$`   
Required: No

 ** Id **   <a name="WAF-Type-WebACLSummary-Id"></a>
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.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** LockToken **   <a name="WAF-Type-WebACLSummary-LockToken"></a>
A token used for optimistic locking. AWS WAF returns a token to your `get` and `list` 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 like `update` and `delete`. AWS 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 a `WAFOptimisticLockException`. If this happens, perform another `get`, and use the new token returned by that operation.   
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 36.  
Pattern: `^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$`   
Required: No

 ** Name **   <a name="WAF-Type-WebACLSummary-Name"></a>
The name of the web ACL. You cannot change the name of a web ACL after you create it.  
Type: String  
Length Constraints: Minimum length of 1. Maximum length of 128.  
Pattern: `^[\w\-]+$`   
Required: No

## See Also
<a name="API_WebACLSummary_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/WebACLSummary) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/WebACLSummary) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/WebACLSummary) 

# XssMatchStatement
<a name="API_XssMatchStatement"></a>

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. 

## Contents
<a name="API_XssMatchStatement_Contents"></a>

 ** FieldToMatch **   <a name="WAF-Type-XssMatchStatement-FieldToMatch"></a>
The part of the web request that you want AWS WAF to inspect.   
Type: [FieldToMatch](API_FieldToMatch.md) object  
Required: Yes

 ** TextTransformations **   <a name="WAF-Type-XssMatchStatement-TextTransformations"></a>
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, AWS WAF performs all transformations on the specified content, starting from the lowest priority setting, and then uses the transformed component contents.   
Type: Array of [TextTransformation](API_TextTransformation.md) objects  
Array Members: Minimum number of 1 item.  
Required: Yes

## See Also
<a name="API_XssMatchStatement_SeeAlso"></a>

For more information about using this API in one of the language-specific AWS SDKs, see the following:
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/wafv2-2019-07-29/XssMatchStatement) 
+  [AWS SDK for Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/wafv2-2019-07-29/XssMatchStatement) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/wafv2-2019-07-29/XssMatchStatement)