import { JsonBodyProps } from './JsonBodyProps';
import { Value } from '../../../cloudformation/Value';
import { SingleQueryArgumentProps } from './SingleQueryArgumentProps';
import { HeadersProps } from './HeadersProps';
import { CookiesProps } from './CookiesProps';
import { BodyProps } from './BodyProps';
import { SingleHeaderProps } from './SingleHeaderProps';
/**
  The part of the web request that you want AWS WAF to inspect. Include the single <code>FieldToMatch</code> type that you want to inspect, with additional specifications as needed, according to the type. You specify a single request component in <code>FieldToMatch</code> 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.
  For full documentation go to <a href="http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-fieldtomatch.html">the AWS Docs</a>
*/
export interface FieldToMatchProps {
    /** <code>JsonBody</code>  <a name="cfn-wafv2-rulegroup-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.<br />
  A limited amount of the request body is forwarded to AWS WAF for inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB (16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL’s <code>AssociationConfig</code>, for additional processing fees.<br />
  For information about how to handle oversized request bodies, see the <code>JsonBody</code> object configuration.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    jsonBody?: JsonBodyProps;
    /** <code>AllQueryArguments</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-allqueryarguments"></a>
  Inspect all query arguments.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    allQueryArguments?: Value<any>;
    /** <code>SingleQueryArgument</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-singlequeryargument"></a>
  Inspect a single query argument. Provide the name of the query argument to inspect, such as
  UserName: r
  SalesRegion: The name can be up to 30 characters long and isn’t case sensitive.<br />
  Example JSON: <code>&quot;SingleQueryArgument&quot;: { &quot;Name&quot;: &quot;myArgument&quot; }</code><br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    singleQueryArgument?: SingleQueryArgumentProps;
    /** <code>UriPath</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-uripath"></a>
  Inspect the request URI path. This is the part of the web request that identifies a resource, for example, <code>/images/daily-ad.jpg</code>.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    uriPath?: Value<any>;
    /** <code>QueryString</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-querystring"></a>
  Inspect the query string. This is the part of a URL that appears after a <code>?</code> character, if any.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    queryString?: Value<any>;
    /** <code>Headers</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-headers"></a>
  Inspect the request headers. You must configure scope and pattern matching filters in the <code>Headers</code> object, to define the set of headers to and the parts of the headers that AWS WAF inspects.<br />
  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 <code>Headers</code> object. AWS WAF applies the pattern matching filters to the headers that it receives from the underlying host service.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    headers?: HeadersProps;
    /** <code>Cookies</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-cookies"></a>
  Inspect the request cookies. You must configure scope and pattern matching filters in the <code>Cookies</code> object, to define the set of cookies and the parts of the cookies that AWS WAF inspects.<br />
  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 <code>Cookies</code> object. AWS WAF applies the pattern matching filters to the cookies that it receives from the underlying host service.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    cookies?: CookiesProps;
    /** <code>Method</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-method"></a>
  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    method?: Value<any>;
    /** <code>Body</code>  <a name="cfn-wafv2-rulegroup-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.<br />
  A limited amount of the request body is forwarded to AWS WAF for inspection by the underlying host service. For regional resources, the limit is 8 KB (8,192 bytes) and for CloudFront distributions, the limit is 16 KB (16,384 bytes). For CloudFront distributions, you can increase the limit in the web ACL’s <code>AssociationConfig</code>, for additional processing fees.<br />
  For information about how to handle oversized request bodies, see the <code>Body</code> object configuration.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    body?: BodyProps;
    /** <code>SingleHeader</code>  <a name="cfn-wafv2-rulegroup-fieldtomatch-singleheader"></a>
  Inspect a single header. Provide the name of the header to inspect, for example, <code>User-Agent</code> or <code>Referer</code>. This setting isn’t case sensitive.<br />
  Example JSON: <code>&quot;SingleHeader&quot;: { &quot;Name&quot;: &quot;haystack&quot; }</code><br />
  Alternately, you can filter and inspect all headers with the <code>Headers</code> <code>FieldToMatch</code> setting.<br />
  
  Required: No<br />
  
  Update requires: <a href="https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-no-interrupt">No interruption</a> */
    singleHeader?: SingleHeaderProps;
}
