Class: AWS.WAFV2

Inherits:
AWS.Service show all
Identifier:
wafv2
API Version:
2019-07-29
Defined in:
(unknown)

Overview

Constructs a service interface object. Each API operation is exposed as a function on service.

Service Description

Note: This is the latest version of the AWS WAF API, released in November, 2019. The names of the entities that you use to access this API, like endpoints and namespaces, all have the versioning information added, like "V2" or "v2", to distinguish from the prior version. We recommend migrating your resources to this version, because it has a number of significant improvements. If you used AWS WAF prior to this release, you can't use this AWS WAFV2 API to access any AWS WAF resources that you created before. You can access your old rules, web ACLs, and other AWS WAF resources only through the AWS WAF Classic APIs. The AWS WAF Classic APIs have retained the prior names, endpoints, and namespaces. For information, including how to migrate your AWS WAF resources to this version, see the AWS WAF Developer Guide.

AWS WAF is a web application firewall that lets you monitor the HTTP and HTTPS requests that are forwarded to Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API. AWS WAF also lets you control access to your content. Based on conditions that you specify, such as the IP addresses that requests originate from or the values of query strings, the API Gateway REST API, CloudFront distribution, the Application Load Balancer, or the AWS AppSync GraphQL API responds to requests either with the requested content or with an HTTP 403 status code (Forbidden). You also can configure CloudFront to return a custom error page when a request is blocked.

This API guide is for developers who need detailed information about AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use AWS WAF, see the AWS WAF Developer Guide.

You can make calls using the endpoints listed in AWS Service Endpoints for AWS WAF.

  • For regional applications, you can use any of the endpoints in the list. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

  • For AWS CloudFront applications, you must use the API endpoint listed for US East (N. Virginia): us-east-1.

Alternatively, you can use one of the AWS SDKs to access an API that's tailored to the programming language or platform that you're using. For more information, see AWS SDKs.

We currently provide two versions of the AWS WAF API: this API and the prior versions, the classic AWS WAF APIs. This new API provides the same functionality as the older versions, with the following major improvements:

  • You use one API for both global and regional applications. Where you need to distinguish the scope, you specify a Scope parameter and set it to CLOUDFRONT or REGIONAL.

  • You can define a Web ACL or rule group with a single call, and update it with a single call. You define all rule specifications in JSON format, and pass them to your rule group or Web ACL calls.

  • The limits AWS WAF places on the use of rules more closely reflects the cost of running each type of rule. Rule groups include capacity settings, so you know the maximum cost of a rule group when you use it.

Sending a Request Using WAFV2

var wafv2 = new AWS.WAFV2();
wafv2.associateWebACL(params, function (err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Locking the API Version

In order to ensure that the WAFV2 object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var wafv2 = new AWS.WAFV2({apiVersion: '2019-07-29'});

You can also set the API version globally in AWS.config.apiVersions using the wafv2 service identifier:

AWS.config.apiVersions = {
  wafv2: '2019-07-29',
  // other service API versions
};

var wafv2 = new AWS.WAFV2();

Version:

  • 2019-07-29

Constructor Summary collapse

Property Summary collapse

Properties inherited from AWS.Service

apiVersions

Method Summary collapse

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

new AWS.WAFV2(options = {}) ⇒ Object

Constructs a service object. This object has one method for each API operation.

Examples:

Constructing a WAFV2 object

var wafv2 = new AWS.WAFV2({apiVersion: '2019-07-29'});

Options Hash (options):

  • params (map)

    An optional map of parameters to bind to every request sent by this service object. For more information on bound parameters, see "Working with Services" in the Getting Started Guide.

  • endpoint (String|AWS.Endpoint)

    The endpoint URI to send requests to. The default endpoint is built from the configured region. The endpoint should be a string like 'https://{service}.{region}.amazonaws.com' or an Endpoint object.

  • accessKeyId (String)

    your AWS access key ID.

  • secretAccessKey (String)

    your AWS secret access key.

  • sessionToken (AWS.Credentials)

    the optional AWS session token to sign requests with.

  • credentials (AWS.Credentials)

    the AWS credentials to sign requests with. You can either specify this object, or specify the accessKeyId and secretAccessKey options directly.

  • credentialProvider (AWS.CredentialProviderChain)

    the provider chain used to resolve credentials if no static credentials property is set.

  • region (String)

    the region to send service requests to. See AWS.WAFV2.region for more information.

  • maxRetries (Integer)

    the maximum amount of retries to attempt with a request. See AWS.WAFV2.maxRetries for more information.

  • maxRedirects (Integer)

    the maximum amount of redirects to follow with a request. See AWS.WAFV2.maxRedirects for more information.

  • sslEnabled (Boolean)

    whether to enable SSL for requests.

  • paramValidation (Boolean|map)

    whether input parameters should be validated against the operation description before sending the request. Defaults to true. Pass a map to enable any of the following specific validation features:

    • min [Boolean] — Validates that a value meets the min constraint. This is enabled by default when paramValidation is set to true.
    • max [Boolean] — Validates that a value meets the max constraint.
    • pattern [Boolean] — Validates that a string value matches a regular expression.
    • enum [Boolean] — Validates that a string value matches one of the allowable enum values.
  • computeChecksums (Boolean)

    whether to compute checksums for payload bodies when the service accepts it (currently supported in S3 only)

  • convertResponseTypes (Boolean)

    whether types are converted when parsing response data. Currently only supported for JSON based services. Turning this off may improve performance on large response payloads. Defaults to true.

  • correctClockSkew (Boolean)

    whether to apply a clock skew correction and retry requests that fail because of an skewed client clock. Defaults to false.

  • s3ForcePathStyle (Boolean)

    whether to force path style URLs for S3 objects.

  • s3BucketEndpoint (Boolean)

    whether the provided endpoint addresses an individual bucket (false if it addresses the root API endpoint). Note that setting this configuration option requires an endpoint to be provided explicitly to the service constructor.

  • s3DisableBodySigning (Boolean)

    whether S3 body signing should be disabled when using signature version v4. Body signing can only be disabled when using https. Defaults to true.

  • s3UsEast1RegionalEndpoint ('legacy'|'regional')

    when region is set to 'us-east-1', whether to send s3 request to global endpoints or 'us-east-1' regional endpoints. This config is only applicable to S3 client. Defaults to legacy

  • s3UseArnRegion (Boolean)

    whether to override the request region with the region inferred from requested resource's ARN. Only available for S3 buckets Defaults to true

  • retryDelayOptions (map)

    A set of options to configure the retry delay on retryable errors. Currently supported options are:

    • base [Integer] — The base number of milliseconds to use in the exponential backoff for operation retries. Defaults to 100 ms for all services except DynamoDB, where it defaults to 50ms.
    • customBackoff [function] — A custom function that accepts a retry count and error and returns the amount of time to delay in milliseconds. If the result is a non-zero negative value, no further retry attempts will be made. The base option will be ignored if this option is supplied. The function is only called for retryable errors.
  • httpOptions (map)

    A set of options to pass to the low-level HTTP request. Currently supported options are:

    • proxy [String] — the URL to proxy requests through
    • agent [http.Agent, https.Agent] — the Agent object to perform HTTP requests with. Used for connection pooling. Defaults to the global agent (http.globalAgent) for non-SSL connections. Note that for SSL connections, a special Agent object is used in order to enable peer certificate verification. This feature is only available in the Node.js environment.
    • connectTimeout [Integer] — Sets the socket to timeout after failing to establish a connection with the server after connectTimeout milliseconds. This timeout has no effect once a socket connection has been established.
    • timeout [Integer] — Sets the socket to timeout after timeout milliseconds of inactivity on the socket. Defaults to two minutes (120000).
    • xhrAsync [Boolean] — Whether the SDK will send asynchronous HTTP requests. Used in the browser environment only. Set to false to send requests synchronously. Defaults to true (async on).
    • xhrWithCredentials [Boolean] — Sets the "withCredentials" property of an XMLHttpRequest object. Used in the browser environment only. Defaults to false.
  • apiVersion (String, Date)

    a String in YYYY-MM-DD format (or a date) that represents the latest possible API version that can be used in all services (unless overridden by apiVersions). Specify 'latest' to use the latest possible version.

  • apiVersions (map<String, String|Date>)

    a map of service identifiers (the lowercase service class name) with the API version to use when instantiating a service. Specify 'latest' for each individual that can use the latest available version.

  • logger (#write, #log)

    an object that responds to .write() (like a stream) or .log() (like the console object) in order to log information about requests

  • systemClockOffset (Number)

    an offset value in milliseconds to apply to all signing times. Use this to compensate for clock skew when your system may be out of sync with the service time. Note that this configuration option can only be applied to the global AWS.config object and cannot be overridden in service-specific configuration. Defaults to 0 milliseconds.

  • signatureVersion (String)

    the signature version to sign requests with (overriding the API configuration). Possible values are: 'v2', 'v3', 'v4'.

  • signatureCache (Boolean)

    whether the signature to sign requests with (overriding the API configuration) is cached. Only applies to the signature version 'v4'. Defaults to true.

  • dynamoDbCrc32 (Boolean)

    whether to validate the CRC32 checksum of HTTP response bodies returned by DynamoDB. Default: true.

  • useAccelerateEndpoint (Boolean)

    Whether to use the S3 Transfer Acceleration endpoint with the S3 service. Default: false.

  • clientSideMonitoring (Boolean)

    whether to collect and publish this client's performance metrics of all its API requests.

  • endpointDiscoveryEnabled (Boolean|undefined)

    whether to call operations with endpoints given by service dynamically. Setting this

  • endpointCacheSize (Number)

    the size of the global cache storing endpoints from endpoint discovery operations. Once endpoint cache is created, updating this setting cannot change existing cache size. Defaults to 1000

  • hostPrefixEnabled (Boolean)

    whether to marshal request parameters to the prefix of hostname. Defaults to true.

  • stsRegionalEndpoints ('legacy'|'regional')

    whether to send sts request to global endpoints or regional endpoints. Defaults to 'legacy'.

Property Details

endpointAWS.Endpoint (readwrite)

Returns an Endpoint object representing the endpoint URL for service requests.

Returns:

  • (AWS.Endpoint)

    an Endpoint object representing the endpoint URL for service requests.

Method Details

associateWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Associates a Web ACL with a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To associate a Web ACL, in the CloudFront call UpdateDistribution, set the web ACL ID to the Amazon Resource Name (ARN) of the Web ACL. For information, see UpdateDistribution.

Service Reference:

Examples:

Calling the associateWebACL operation

var params = {
  ResourceArn: 'STRING_VALUE', /* required */
  WebACLArn: 'STRING_VALUE' /* required */
};
wafv2.associateWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • WebACLArn — (String)

      The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

      The ARN must be in one of the following formats:

      • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

      • For an API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

      • For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

checkCapacity(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Returns the web ACL capacity unit (WCU) requirements for a specified scope and set of rules. You can use this to check the capacity requirements for the rules you want to use in a RuleGroup or WebACL.

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. The WCU limit for web ACLs is 1,500.

Service Reference:

Examples:

Calling the checkCapacity operation

var params = {
  Rules: [ /* required */
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            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,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
        },
        Block: {
        },
        Count: {
        }
      },
      OverrideAction: {
        Count: {
        },
        None: {
        }
      }
    },
    /* more items */
  ],
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.checkCapacity(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Rules — (Array<map>)

      An array of Rule that you're configuring to use in a rule group or web ACL.

      • Namerequired — (String)

        The name of the rule. You can't change the name of a Rule after you create it.

      • Priorityrequired — (Integer)

        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.

      • Statementrequired — (map)

        The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

        • ByteMatchStatement — (map)

          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 refered to as a string match statement.

          • SearchStringrequired — (Buffer, Typed Array, Blob, String)

            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. The maximum length of the value is 50 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.

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

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
          • PositionalConstraintrequired — (String)

            The area within the portion of a 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_WORD

            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 ). In addition, SearchString must be a word, which means that both of the following are true:

            • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

            • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

            EXACTLY

            The value of the specified part of the web request must exactly match the value of SearchString.

            STARTS_WITH

            The value of SearchString must appear at the beginning of the specified part of the web request.

            ENDS_WITH

            The value of SearchString must appear at the end of the specified part of the web request.

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
        • SqliMatchStatement — (map)

          Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • XssMatchStatement — (map)

          A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • SizeConstraintStatement — (map)

          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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

          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.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • ComparisonOperatorrequired — (String)

            The operator to use to compare the request part to the size setting.

            Possible values include:
            • "EQ"
            • "NE"
            • "LE"
            • "LT"
            • "GE"
            • "GT"
          • Sizerequired — (Integer)

            The size, in byte, to compare to the request part, after any transformations.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • GeoMatchStatement — (map)

          A rule statement used to identify web requests based on country of origin.

          • CountryCodes — (Array<String>)

            An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • ForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • RuleGroupReferenceStatement — (map)

          A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

          You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the entity.

          • ExcludedRules — (Array<map>)

            The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

            • Namerequired — (String)

              The name of the rule to exclude.

        • IPSetReferenceStatement — (map)

          A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

          Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the IPSet that this statement references.

          • IPSetForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
            • Positionrequired — (String)

              The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

              The options for this setting are the following:

              • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

              • LAST - Inspect the last IP address in the list of IP addresses in the header.

              • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

              Possible values include:
              • "FIRST"
              • "LAST"
              • "ANY"
        • RegexPatternSetReferenceStatement — (map)

          A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

          Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • RateBasedStatement — (map)

          A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

          When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

          You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

          • An IP match statement with an IP set that specified the address 192.0.2.44.

          • A string match statement that searches in the User-Agent header for the string BadBot.

          In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

          You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • Limitrequired — (Integer)

            The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

          • AggregateKeyTyperequired — (String)

            Setting that indicates how to aggregate the request counts. The options are the following:

            • IP - Aggregate the request counts on the IP address from the web request origin.

            • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

            Possible values include:
            • "IP"
            • "FORWARDED_IP"
          • ForwardedIPConfig — (map)

            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 is required if AggregateKeyType is set to FORWARDED_IP.

            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • AndStatement — (map)

          A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with AND logic. You can use any statements that can be nested.

        • OrStatement — (map)

          A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with OR logic. You can use any statements that can be nested.

        • NotStatement — (map)

          A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

        • ManagedRuleGroupStatement — (map)

          A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

          You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • VendorNamerequired — (String)

            The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

          • Namerequired — (String)

            The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

          • ExcludedRules — (Array<map>)

            The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

            • Namerequired — (String)

              The name of the rule to exclude.

      • Action — (map)

        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.

        • Block — (map)

          Instructs AWS WAF to block the web request.

        • Allow — (map)

          Instructs AWS WAF to allow the web request.

        • Count — (map)

          Instructs AWS WAF to count the web request and allow it.

      • OverrideAction — (map)

        The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

        Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

        In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

        • If the rule statement references a rule group, use this override action setting and not the action setting.

        • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

        • Count — (map)

          Override the rule action setting to count.

        • None — (map)

          Don't override the rule action setting.

      • VisibilityConfigrequired — (map)

        Defines and enables Amazon CloudWatch metrics and web request sample collection.

        • SampledRequestsEnabledrequired — (Boolean)

          A boolean indicating 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.

        • CloudWatchMetricsEnabledrequired — (Boolean)

          A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

        • MetricNamerequired — (String)

          A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Capacity — (Integer)

        The capacity required by the rules and scope.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createIPSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Creates an IPSet, which you use to identify web requests that originate from specific IP addresses or ranges of IP addresses. For example, if you're receiving a lot of requests from a ranges of IP addresses, you can configure AWS WAF to block them using an IPSet that lists those IP addresses.

Service Reference:

Examples:

Calling the createIPSet operation

var params = {
  Addresses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  IPAddressVersion: IPV4 | IPV6, /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createIPSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Description — (String)

      A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    • IPAddressVersion — (String)

      Specify IPV4 or IPV6.

      Possible values include:
      • "IPV4"
      • "IPV6"
    • Addresses — (Array<String>)

      Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

      Examples:

      • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

      • To configure AWS WAF to allow, block, or count 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.

      • To configure AWS WAF to allow, block, or count 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.

    • Tags — (Array<map>)

      An array of key:value pairs to associate with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Summary — (map)

        High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

        • Name — (String)

          The name of the IP set. You cannot change the name of an IPSet after you create it.

        • Id — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createRegexPatternSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Creates a RegexPatternSet, which you reference in a RegexPatternSetReferenceStatement, to have AWS WAF inspect a web request component for the specified patterns.

Service Reference:

Examples:

Calling the createRegexPatternSet operation

var params = {
  Name: 'STRING_VALUE', /* required */
  RegularExpressionList: [ /* required */
    {
      RegexString: 'STRING_VALUE'
    },
    /* more items */
  ],
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE',
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the set. You cannot change the name after you create the set.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Description — (String)

      A description of the set that helps with identification. You cannot change the description of a set after you create it.

    • RegularExpressionList — (Array<map>)

      Array of regular expression strings.

      • RegexString — (String)

        The string representing the regular expression.

    • Tags — (Array<map>)

      An array of key:value pairs to associate with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Summary — (map)

        High-level information about a RegexPatternSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN, that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.

        • Name — (String)

          The name of the data type instance. You cannot change the name after you create the instance.

        • Id — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the set that helps with identification. You cannot change the description of a set after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createRuleGroup(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Creates a RuleGroup per the specifications provided.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Service Reference:

Examples:

Calling the createRuleGroup operation

var params = {
  Capacity: 'NUMBER_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VisibilityConfig: { /* required */
    CloudWatchMetricsEnabled: true || false, /* required */
    MetricName: 'STRING_VALUE', /* required */
    SampledRequestsEnabled: true || false /* required */
  },
  Description: 'STRING_VALUE',
  Rules: [
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            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,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
        },
        Block: {
        },
        Count: {
        }
      },
      OverrideAction: {
        Count: {
        },
        None: {
        }
      }
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Capacity — (Integer)

      The web ACL capacity units (WCUs) required for this rule group.

      When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

      AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

    • Description — (String)

      A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    • Rules — (Array<map>)

      The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

      • Namerequired — (String)

        The name of the rule. You can't change the name of a Rule after you create it.

      • Priorityrequired — (Integer)

        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.

      • Statementrequired — (map)

        The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

        • ByteMatchStatement — (map)

          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 refered to as a string match statement.

          • SearchStringrequired — (Buffer, Typed Array, Blob, String)

            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. The maximum length of the value is 50 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.

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

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
          • PositionalConstraintrequired — (String)

            The area within the portion of a 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_WORD

            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 ). In addition, SearchString must be a word, which means that both of the following are true:

            • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

            • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

            EXACTLY

            The value of the specified part of the web request must exactly match the value of SearchString.

            STARTS_WITH

            The value of SearchString must appear at the beginning of the specified part of the web request.

            ENDS_WITH

            The value of SearchString must appear at the end of the specified part of the web request.

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
        • SqliMatchStatement — (map)

          Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • XssMatchStatement — (map)

          A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • SizeConstraintStatement — (map)

          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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

          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.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • ComparisonOperatorrequired — (String)

            The operator to use to compare the request part to the size setting.

            Possible values include:
            • "EQ"
            • "NE"
            • "LE"
            • "LT"
            • "GE"
            • "GT"
          • Sizerequired — (Integer)

            The size, in byte, to compare to the request part, after any transformations.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • GeoMatchStatement — (map)

          A rule statement used to identify web requests based on country of origin.

          • CountryCodes — (Array<String>)

            An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • ForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • RuleGroupReferenceStatement — (map)

          A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

          You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the entity.

          • ExcludedRules — (Array<map>)

            The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

            • Namerequired — (String)

              The name of the rule to exclude.

        • IPSetReferenceStatement — (map)

          A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

          Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the IPSet that this statement references.

          • IPSetForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
            • Positionrequired — (String)

              The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

              The options for this setting are the following:

              • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

              • LAST - Inspect the last IP address in the list of IP addresses in the header.

              • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

              Possible values include:
              • "FIRST"
              • "LAST"
              • "ANY"
        • RegexPatternSetReferenceStatement — (map)

          A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

          Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • RateBasedStatement — (map)

          A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

          When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

          You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

          • An IP match statement with an IP set that specified the address 192.0.2.44.

          • A string match statement that searches in the User-Agent header for the string BadBot.

          In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

          You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • Limitrequired — (Integer)

            The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

          • AggregateKeyTyperequired — (String)

            Setting that indicates how to aggregate the request counts. The options are the following:

            • IP - Aggregate the request counts on the IP address from the web request origin.

            • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

            Possible values include:
            • "IP"
            • "FORWARDED_IP"
          • ForwardedIPConfig — (map)

            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 is required if AggregateKeyType is set to FORWARDED_IP.

            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • AndStatement — (map)

          A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with AND logic. You can use any statements that can be nested.

        • OrStatement — (map)

          A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with OR logic. You can use any statements that can be nested.

        • NotStatement — (map)

          A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

        • ManagedRuleGroupStatement — (map)

          A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

          You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • VendorNamerequired — (String)

            The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

          • Namerequired — (String)

            The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

          • ExcludedRules — (Array<map>)

            The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

            • Namerequired — (String)

              The name of the rule to exclude.

      • Action — (map)

        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.

        • Block — (map)

          Instructs AWS WAF to block the web request.

        • Allow — (map)

          Instructs AWS WAF to allow the web request.

        • Count — (map)

          Instructs AWS WAF to count the web request and allow it.

      • OverrideAction — (map)

        The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

        Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

        In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

        • If the rule statement references a rule group, use this override action setting and not the action setting.

        • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

        • Count — (map)

          Override the rule action setting to count.

        • None — (map)

          Don't override the rule action setting.

      • VisibilityConfigrequired — (map)

        Defines and enables Amazon CloudWatch metrics and web request sample collection.

        • SampledRequestsEnabledrequired — (Boolean)

          A boolean indicating 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.

        • CloudWatchMetricsEnabledrequired — (Boolean)

          A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

        • MetricNamerequired — (String)

          A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • VisibilityConfig — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabledrequired — (Boolean)

        A boolean indicating 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.

      • CloudWatchMetricsEnabledrequired — (Boolean)

        A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

      • MetricNamerequired — (String)

        A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • Tags — (Array<map>)

      An array of key:value pairs to associate with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Summary — (map)

        High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

        • Name — (String)

          The name of the data type instance. You cannot change the name after you create the instance.

        • Id — (String)

          A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

createWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Creates a WebACL per the specifications provided.

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

Service Reference:

Examples:

Calling the createWebACL operation

var params = {
  DefaultAction: { /* required */
    Allow: {
    },
    Block: {
    }
  },
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VisibilityConfig: { /* required */
    CloudWatchMetricsEnabled: true || false, /* required */
    MetricName: 'STRING_VALUE', /* required */
    SampledRequestsEnabled: true || false /* required */
  },
  Description: 'STRING_VALUE',
  Rules: [
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            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,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
        },
        Block: {
        },
        Count: {
        }
      },
      OverrideAction: {
        Count: {
        },
        None: {
        }
      }
    },
    /* more items */
  ],
  Tags: [
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.createWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • DefaultAction — (map)

      The action to perform if none of the Rules contained in the WebACL match.

      • Block — (map)

        Specifies that AWS WAF should block requests by default.

      • Allow — (map)

        Specifies that AWS WAF should allow requests by default.

    • Description — (String)

      A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    • Rules — (Array<map>)

      The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

      • Namerequired — (String)

        The name of the rule. You can't change the name of a Rule after you create it.

      • Priorityrequired — (Integer)

        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.

      • Statementrequired — (map)

        The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

        • ByteMatchStatement — (map)

          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 refered to as a string match statement.

          • SearchStringrequired — (Buffer, Typed Array, Blob, String)

            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. The maximum length of the value is 50 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.

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

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
          • PositionalConstraintrequired — (String)

            The area within the portion of a 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_WORD

            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 ). In addition, SearchString must be a word, which means that both of the following are true:

            • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

            • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

            EXACTLY

            The value of the specified part of the web request must exactly match the value of SearchString.

            STARTS_WITH

            The value of SearchString must appear at the beginning of the specified part of the web request.

            ENDS_WITH

            The value of SearchString must appear at the end of the specified part of the web request.

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
        • SqliMatchStatement — (map)

          Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • XssMatchStatement — (map)

          A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • SizeConstraintStatement — (map)

          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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

          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.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • ComparisonOperatorrequired — (String)

            The operator to use to compare the request part to the size setting.

            Possible values include:
            • "EQ"
            • "NE"
            • "LE"
            • "LT"
            • "GE"
            • "GT"
          • Sizerequired — (Integer)

            The size, in byte, to compare to the request part, after any transformations.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • GeoMatchStatement — (map)

          A rule statement used to identify web requests based on country of origin.

          • CountryCodes — (Array<String>)

            An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • ForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • RuleGroupReferenceStatement — (map)

          A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

          You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the entity.

          • ExcludedRules — (Array<map>)

            The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

            • Namerequired — (String)

              The name of the rule to exclude.

        • IPSetReferenceStatement — (map)

          A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

          Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the IPSet that this statement references.

          • IPSetForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
            • Positionrequired — (String)

              The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

              The options for this setting are the following:

              • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

              • LAST - Inspect the last IP address in the list of IP addresses in the header.

              • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

              Possible values include:
              • "FIRST"
              • "LAST"
              • "ANY"
        • RegexPatternSetReferenceStatement — (map)

          A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

          Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • RateBasedStatement — (map)

          A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

          When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

          You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

          • An IP match statement with an IP set that specified the address 192.0.2.44.

          • A string match statement that searches in the User-Agent header for the string BadBot.

          In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

          You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • Limitrequired — (Integer)

            The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

          • AggregateKeyTyperequired — (String)

            Setting that indicates how to aggregate the request counts. The options are the following:

            • IP - Aggregate the request counts on the IP address from the web request origin.

            • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

            Possible values include:
            • "IP"
            • "FORWARDED_IP"
          • ForwardedIPConfig — (map)

            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 is required if AggregateKeyType is set to FORWARDED_IP.

            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • AndStatement — (map)

          A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with AND logic. You can use any statements that can be nested.

        • OrStatement — (map)

          A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with OR logic. You can use any statements that can be nested.

        • NotStatement — (map)

          A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

        • ManagedRuleGroupStatement — (map)

          A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

          You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • VendorNamerequired — (String)

            The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

          • Namerequired — (String)

            The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

          • ExcludedRules — (Array<map>)

            The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

            • Namerequired — (String)

              The name of the rule to exclude.

      • Action — (map)

        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.

        • Block — (map)

          Instructs AWS WAF to block the web request.

        • Allow — (map)

          Instructs AWS WAF to allow the web request.

        • Count — (map)

          Instructs AWS WAF to count the web request and allow it.

      • OverrideAction — (map)

        The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

        Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

        In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

        • If the rule statement references a rule group, use this override action setting and not the action setting.

        • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

        • Count — (map)

          Override the rule action setting to count.

        • None — (map)

          Don't override the rule action setting.

      • VisibilityConfigrequired — (map)

        Defines and enables Amazon CloudWatch metrics and web request sample collection.

        • SampledRequestsEnabledrequired — (Boolean)

          A boolean indicating 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.

        • CloudWatchMetricsEnabledrequired — (Boolean)

          A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

        • MetricNamerequired — (String)

          A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • VisibilityConfig — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabledrequired — (Boolean)

        A boolean indicating 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.

      • CloudWatchMetricsEnabledrequired — (Boolean)

        A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

      • MetricNamerequired — (String)

        A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • Tags — (Array<map>)

      An array of key:value pairs to associate with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Summary — (map)

        High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you provide to operations like AssociateWebACL.

        • Name — (String)

          The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

        • Id — (String)

          The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteFirewallManagerRuleGroups(params = {}, callback) ⇒ AWS.Request

Deletes all rule groups that are managed by AWS Firewall Manager for the specified web ACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

Service Reference:

Examples:

Calling the deleteFirewallManagerRuleGroups operation

var params = {
  WebACLArn: 'STRING_VALUE', /* required */
  WebACLLockToken: 'STRING_VALUE' /* required */
};
wafv2.deleteFirewallManagerRuleGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • WebACLArn — (String)

      The Amazon Resource Name (ARN) of the web ACL.

    • WebACLLockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextWebACLLockToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteIPSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Deletes the specified IPSet.

Service Reference:

Examples:

Calling the deleteIPSet operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.deleteIPSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Deletes the LoggingConfiguration from the specified web ACL.

Service Reference:

Examples:

Calling the deleteLoggingConfiguration operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.deleteLoggingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deletePermissionPolicy(params = {}, callback) ⇒ AWS.Request

Permanently deletes an IAM policy from the specified rule group.

You must be the owner of the rule group to perform this operation.

Service Reference:

Examples:

Calling the deletePermissionPolicy operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.deletePermissionPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.

      You must be the owner of the rule group to perform this operation.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRegexPatternSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Deletes the specified RegexPatternSet.

Service Reference:

Examples:

Calling the deleteRegexPatternSet operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.deleteRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the set. You cannot change the name after you create the set.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteRuleGroup(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Deletes the specified RuleGroup.

Service Reference:

Examples:

Calling the deleteRuleGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.deleteRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

deleteWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the specified WebACL.

Service Reference:

Examples:

Calling the deleteWebACL operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.deleteWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

describeManagedRuleGroup(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Provides high-level information for a managed rule group, including descriptions of the rules.

Service Reference:

Examples:

Calling the describeManagedRuleGroup operation

var params = {
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VendorName: 'STRING_VALUE' /* required */
};
wafv2.describeManagedRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • VendorName — (String)

      The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

    • Name — (String)

      The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Capacity — (Integer)

        The web ACL capacity units (WCUs) required for this rule group. AWS WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

      • Rules — (Array<map>)

        • Name — (String)

          The name of the rule.

        • Action — (map)
          Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

          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.

          • Block — (map)

            Instructs AWS WAF to block the web request.

          • Allow — (map)

            Instructs AWS WAF to allow the web request.

          • Count — (map)

            Instructs AWS WAF to count the web request and allow it.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

disassociateWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Disassociates a Web ACL from a regional application resource. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

For AWS CloudFront, don't use this call. Instead, use your CloudFront distribution configuration. To disassociate a Web ACL, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution.

Service Reference:

Examples:

Calling the disassociateWebACL operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.disassociateWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.

      The ARN must be in one of the following formats:

      • For an Application Load Balancer: arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id

      • For an API Gateway REST API: arn:aws:apigateway:region::/restapis/api-id/stages/stage-name

      • For an AppSync GraphQL API: arn:aws:appsync:region:account-id:apis/GraphQLApiId

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getIPSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the specified IPSet.

Service Reference:

Examples:

Calling the getIPSet operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.getIPSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • IPSet — (map)

        • Namerequired — (String)

          The name of the IP set. You cannot change the name of an IPSet after you create it.

        • Idrequired — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the entity.

        • Description — (String)

          A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

        • IPAddressVersionrequired — (String)

          Specify IPV4 or IPV6.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • Addressesrequired — (Array<String>)

          Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

          Examples:

          • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

          • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

          • To configure AWS WAF to allow, block, or count 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.

          • To configure AWS WAF to allow, block, or count 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.

      • LockToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Returns the LoggingConfiguration for the specified web ACL.

Service Reference:

Examples:

Calling the getLoggingConfiguration operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.getLoggingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingConfiguration — (map)

        The LoggingConfiguration for the specified web ACL.

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

        • LogDestinationConfigsrequired — (Array<String>)

          The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

        • RedactedFields — (Array<map>)

          The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

          Note: You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
          • SingleHeader — (map)

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

            • Namerequired — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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.

            This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

            • Namerequired — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            Inspect the request body, which 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.

            Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

        • ManagedByFirewallManager — (Boolean)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getPermissionPolicy(params = {}, callback) ⇒ AWS.Request

Returns the IAM policy that is attached to the specified rule group.

You must be the owner of the rule group to perform this operation.

Service Reference:

Examples:

Calling the getPermissionPolicy operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.getPermissionPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • Policy — (String)

        The IAM policy that is attached to the specified rule group.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRateBasedStatementManagedKeys(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the keys that are currently blocked by a rate-based rule. The maximum number of managed keys that can be blocked for a single rate-based rule is 10,000. If more than 10,000 addresses exceed the rate limit, those with the highest rates are blocked.

Examples:

Calling the getRateBasedStatementManagedKeys operation

var params = {
  RuleName: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  WebACLId: 'STRING_VALUE', /* required */
  WebACLName: 'STRING_VALUE' /* required */
};
wafv2.getRateBasedStatementManagedKeys(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • WebACLName — (String)

      The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    • WebACLId — (String)

      The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • RuleName — (String)

      The name of the rate-based rule to get the keys for.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ManagedKeysIPV4 — (map)

        The keys that are of Internet Protocol version 4 (IPv4).

        • IPAddressVersion — (String) Possible values include:
          • "IPV4"
          • "IPV6"
        • Addresses — (Array<String>)

          The IP addresses that are currently blocked.

      • ManagedKeysIPV6 — (map)

        The keys that are of Internet Protocol version 6 (IPv6).

        • IPAddressVersion — (String) Possible values include:
          • "IPV4"
          • "IPV6"
        • Addresses — (Array<String>)

          The IP addresses that are currently blocked.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRegexPatternSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the specified RegexPatternSet.

Service Reference:

Examples:

Calling the getRegexPatternSet operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.getRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the set. You cannot change the name after you create the set.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RegexPatternSet — (map)

        • Name — (String)

          The name of the set. You cannot change the name after you create the set.

        • Id — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

        • Description — (String)

          A description of the set that helps with identification. You cannot change the description of a set after you create it.

        • RegularExpressionList — (Array<map>)

          The regular expression patterns in the set.

          • RegexString — (String)

            The string representing the regular expression.

      • LockToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getRuleGroup(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the specified RuleGroup.

Service Reference:

Examples:

Calling the getRuleGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.getRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • RuleGroup — (map)

        • Namerequired — (String)

          The name of the rule group. You cannot change the name of a rule group after you create it.

        • Idrequired — (String)

          A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Capacityrequired — (Integer)

          The web ACL capacity units (WCUs) required for this rule group.

          When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.

          AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the entity.

        • Description — (String)

          A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

        • Rules — (Array<map>)

          The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

          • Namerequired — (String)

            The name of the rule. You can't change the name of a Rule after you create it.

          • Priorityrequired — (Integer)

            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.

          • Statementrequired — (map)

            The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

            • ByteMatchStatement — (map)

              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 refered to as a string match statement.

              • SearchStringrequired — (Buffer, Typed Array, Blob, String)

                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. The maximum length of the value is 50 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.

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

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
              • PositionalConstraintrequired — (String)

                The area within the portion of a 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_WORD

                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 ). In addition, SearchString must be a word, which means that both of the following are true:

                • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

                • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

                EXACTLY

                The value of the specified part of the web request must exactly match the value of SearchString.

                STARTS_WITH

                The value of SearchString must appear at the beginning of the specified part of the web request.

                ENDS_WITH

                The value of SearchString must appear at the end of the specified part of the web request.

                Possible values include:
                • "EXACTLY"
                • "STARTS_WITH"
                • "ENDS_WITH"
                • "CONTAINS"
                • "CONTAINS_WORD"
            • SqliMatchStatement — (map)

              Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • XssMatchStatement — (map)

              A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • SizeConstraintStatement — (map)

              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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

              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.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • ComparisonOperatorrequired — (String)

                The operator to use to compare the request part to the size setting.

                Possible values include:
                • "EQ"
                • "NE"
                • "LE"
                • "LT"
                • "GE"
                • "GT"
              • Sizerequired — (Integer)

                The size, in byte, to compare to the request part, after any transformations.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • GeoMatchStatement — (map)

              A rule statement used to identify web requests based on country of origin.

              • CountryCodes — (Array<String>)

                An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

              • ForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • RuleGroupReferenceStatement — (map)

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • IPSetReferenceStatement — (map)

              A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

              Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the IPSet that this statement references.

              • IPSetForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
                • Positionrequired — (String)

                  The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

                  The options for this setting are the following:

                  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

                  • LAST - Inspect the last IP address in the list of IP addresses in the header.

                  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

                  Possible values include:
                  • "FIRST"
                  • "LAST"
                  • "ANY"
            • RegexPatternSetReferenceStatement — (map)

              A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

              Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • RateBasedStatement — (map)

              A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

              When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

              You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

              • An IP match statement with an IP set that specified the address 192.0.2.44.

              • A string match statement that searches in the User-Agent header for the string BadBot.

              In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

              You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • Limitrequired — (Integer)

                The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

              • AggregateKeyTyperequired — (String)

                Setting that indicates how to aggregate the request counts. The options are the following:

                • IP - Aggregate the request counts on the IP address from the web request origin.

                • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

                Possible values include:
                • "IP"
                • "FORWARDED_IP"
              • ForwardedIPConfig — (map)

                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 is required if AggregateKeyType is set to FORWARDED_IP.

                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • AndStatement — (map)

              A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with AND logic. You can use any statements that can be nested.

            • OrStatement — (map)

              A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with OR logic. You can use any statements that can be nested.

            • NotStatement — (map)

              A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

            • ManagedRuleGroupStatement — (map)

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • Action — (map)

            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.

            • Block — (map)

              Instructs AWS WAF to block the web request.

            • Allow — (map)

              Instructs AWS WAF to allow the web request.

            • Count — (map)

              Instructs AWS WAF to count the web request and allow it.

          • OverrideAction — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • VisibilityConfigrequired — (map)

          Defines and enables Amazon CloudWatch metrics and web request sample collection.

          • SampledRequestsEnabledrequired — (Boolean)

            A boolean indicating 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.

          • CloudWatchMetricsEnabledrequired — (Boolean)

            A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

          • MetricNamerequired — (String)

            A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

      • LockToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getSampledRequests(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Service Reference:

Examples:

Calling the getSampledRequests operation

var params = {
  MaxItems: 'NUMBER_VALUE', /* required */
  RuleMetricName: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  TimeWindow: { /* required */
    EndTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789, /* required */
    StartTime: new Date || 'Wed Dec 31 1969 16:00:00 GMT-0800 (PST)' || 123456789 /* required */
  },
  WebAclArn: 'STRING_VALUE' /* required */
};
wafv2.getSampledRequests(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • WebAclArn — (String)

      The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.

    • RuleMetricName — (String)

      The metric name assigned to the Rule or RuleGroup for which you want a sample of requests.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • TimeWindow — (map)

      The start date and time and the end date and time of the range for which you want GetSampledRequests to return a sample of requests. You must specify the times in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

      • StartTimerequired — (Date)

        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.

      • EndTimerequired — (Date)

        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.

    • MaxItems — (Integer)

      The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource received during the time range. If your resource received fewer requests than the value of MaxItems, GetSampledRequests returns information about all of them.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • SampledRequests — (Array<map>)

        A complex type that contains detailed information about each of the requests in the sample.

        • Requestrequired — (map)

          A complex type that contains detailed information about the request.

          • ClientIP — (String)

            The IP address that the request originated from. If the web ACL is associated with a CloudFront distribution, this is the value of one of the following fields in CloudFront access logs:

            • c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request

            • x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request

          • Country — (String)

            The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.

          • URI — (String)

            The URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.

          • Method — (String)

            The HTTP method specified in the sampled web request.

          • HTTPVersion — (String)

            The HTTP version specified in the sampled web request, for example, HTTP/1.1.

          • Headers — (Array<map>)

            A complex type that contains the name and value for each header in the sampled web request.

            • Name — (String)

              The name of the HTTP header.

            • Value — (String)

              The value of the HTTP header.

        • Weightrequired — (Integer)

          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.

        • Timestamp — (Date)

          The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

        • Action — (String)

          The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

        • RuleNameWithinRuleGroup — (String)

          The name of the Rule that the request matched. For managed rule groups, the format for this name is <vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the format for this name is <rule group name>#<rule name>. If the rule is not in a rule group, this field is absent.

      • PopulationSize — (Integer)

        The total number of requests from which GetSampledRequests got a sample of MaxItems requests. If PopulationSize is less than MaxItems, the sample includes every request that your AWS resource received during the specified time range.

      • TimeWindow — (map)

        Usually, TimeWindow is the time range that you specified in the GetSampledRequests request. However, if your AWS resource received more than 5,000 requests during the time range that you specified in the request, GetSampledRequests returns the time range for the first 5,000 requests. Times are in Coordinated Universal Time (UTC) format.

        • StartTimerequired — (Date)

          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.

        • EndTimerequired — (Date)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the specified WebACL.

Service Reference:

Examples:

Calling the getWebACL operation

var params = {
  Id: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL /* required */
};
wafv2.getWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • WebACL — (map)

        The Web ACL specification. You can modify the settings in this Web ACL and use it to update this Web ACL or create a new one.

        • Namerequired — (String)

          The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

        • Idrequired — (String)

          A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

        • DefaultActionrequired — (map)

          The action to perform if none of the Rules contained in the WebACL match.

          • Block — (map)

            Specifies that AWS WAF should block requests by default.

          • Allow — (map)

            Specifies that AWS WAF should allow requests by default.

        • Description — (String)

          A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

        • Rules — (Array<map>)

          The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

          • Namerequired — (String)

            The name of the rule. You can't change the name of a Rule after you create it.

          • Priorityrequired — (Integer)

            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.

          • Statementrequired — (map)

            The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

            • ByteMatchStatement — (map)

              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 refered to as a string match statement.

              • SearchStringrequired — (Buffer, Typed Array, Blob, String)

                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. The maximum length of the value is 50 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.

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

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
              • PositionalConstraintrequired — (String)

                The area within the portion of a 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_WORD

                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 ). In addition, SearchString must be a word, which means that both of the following are true:

                • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

                • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

                EXACTLY

                The value of the specified part of the web request must exactly match the value of SearchString.

                STARTS_WITH

                The value of SearchString must appear at the beginning of the specified part of the web request.

                ENDS_WITH

                The value of SearchString must appear at the end of the specified part of the web request.

                Possible values include:
                • "EXACTLY"
                • "STARTS_WITH"
                • "ENDS_WITH"
                • "CONTAINS"
                • "CONTAINS_WORD"
            • SqliMatchStatement — (map)

              Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • XssMatchStatement — (map)

              A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • SizeConstraintStatement — (map)

              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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

              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.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • ComparisonOperatorrequired — (String)

                The operator to use to compare the request part to the size setting.

                Possible values include:
                • "EQ"
                • "NE"
                • "LE"
                • "LT"
                • "GE"
                • "GT"
              • Sizerequired — (Integer)

                The size, in byte, to compare to the request part, after any transformations.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • GeoMatchStatement — (map)

              A rule statement used to identify web requests based on country of origin.

              • CountryCodes — (Array<String>)

                An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

              • ForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • RuleGroupReferenceStatement — (map)

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • IPSetReferenceStatement — (map)

              A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

              Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the IPSet that this statement references.

              • IPSetForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
                • Positionrequired — (String)

                  The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

                  The options for this setting are the following:

                  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

                  • LAST - Inspect the last IP address in the list of IP addresses in the header.

                  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

                  Possible values include:
                  • "FIRST"
                  • "LAST"
                  • "ANY"
            • RegexPatternSetReferenceStatement — (map)

              A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

              Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • RateBasedStatement — (map)

              A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

              When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

              You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

              • An IP match statement with an IP set that specified the address 192.0.2.44.

              • A string match statement that searches in the User-Agent header for the string BadBot.

              In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

              You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • Limitrequired — (Integer)

                The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

              • AggregateKeyTyperequired — (String)

                Setting that indicates how to aggregate the request counts. The options are the following:

                • IP - Aggregate the request counts on the IP address from the web request origin.

                • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

                Possible values include:
                • "IP"
                • "FORWARDED_IP"
              • ForwardedIPConfig — (map)

                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 is required if AggregateKeyType is set to FORWARDED_IP.

                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • AndStatement — (map)

              A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with AND logic. You can use any statements that can be nested.

            • OrStatement — (map)

              A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with OR logic. You can use any statements that can be nested.

            • NotStatement — (map)

              A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

            • ManagedRuleGroupStatement — (map)

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • Action — (map)

            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.

            • Block — (map)

              Instructs AWS WAF to block the web request.

            • Allow — (map)

              Instructs AWS WAF to allow the web request.

            • Count — (map)

              Instructs AWS WAF to count the web request and allow it.

          • OverrideAction — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • VisibilityConfigrequired — (map)

          Defines and enables Amazon CloudWatch metrics and web request sample collection.

          • SampledRequestsEnabledrequired — (Boolean)

            A boolean indicating 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.

          • CloudWatchMetricsEnabledrequired — (Boolean)

            A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

          • MetricNamerequired — (String)

            A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • Capacity — (Integer)

          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. The WCU limit for web ACLs is 1,500.

        • PreProcessFirewallManagerRuleGroups — (Array<map>)

          The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

          In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

          • Namerequired — (String)

            The name of the rule group. You cannot change the name of a rule group after you create it.

          • Priorityrequired — (Integer)

            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.

          • FirewallManagerStatementrequired — (map)

            The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

            • ManagedRuleGroupStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • RuleGroupReferenceStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • OverrideActionrequired — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)
            Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • PostProcessFirewallManagerRuleGroups — (Array<map>)

          The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

          In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

          • Namerequired — (String)

            The name of the rule group. You cannot change the name of a rule group after you create it.

          • Priorityrequired — (Integer)

            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.

          • FirewallManagerStatementrequired — (map)

            The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

            • ManagedRuleGroupStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • RuleGroupReferenceStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • OverrideActionrequired — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)
            Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • ManagedByFirewallManager — (Boolean)

          Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

      • LockToken — (String)

        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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

getWebACLForResource(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the WebACL for the specified resource.

Service Reference:

Examples:

Calling the getWebACLForResource operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.getWebACLForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The ARN (Amazon Resource Name) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • WebACL — (map)

        The Web ACL that is associated with the resource. If there is no associated resource, AWS WAF returns a null Web ACL.

        • Namerequired — (String)

          The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

        • Idrequired — (String)

          A unique identifier for the WebACL. This ID is returned in the responses to create and list commands. You use this ID to do things like get, update, and delete a WebACL.

        • ARNrequired — (String)

          The Amazon Resource Name (ARN) of the Web ACL that you want to associate with the resource.

        • DefaultActionrequired — (map)

          The action to perform if none of the Rules contained in the WebACL match.

          • Block — (map)

            Specifies that AWS WAF should block requests by default.

          • Allow — (map)

            Specifies that AWS WAF should allow requests by default.

        • Description — (String)

          A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

        • Rules — (Array<map>)

          The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

          • Namerequired — (String)

            The name of the rule. You can't change the name of a Rule after you create it.

          • Priorityrequired — (Integer)

            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.

          • Statementrequired — (map)

            The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

            • ByteMatchStatement — (map)

              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 refered to as a string match statement.

              • SearchStringrequired — (Buffer, Typed Array, Blob, String)

                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. The maximum length of the value is 50 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.

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

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
              • PositionalConstraintrequired — (String)

                The area within the portion of a 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_WORD

                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 ). In addition, SearchString must be a word, which means that both of the following are true:

                • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

                • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

                EXACTLY

                The value of the specified part of the web request must exactly match the value of SearchString.

                STARTS_WITH

                The value of SearchString must appear at the beginning of the specified part of the web request.

                ENDS_WITH

                The value of SearchString must appear at the end of the specified part of the web request.

                Possible values include:
                • "EXACTLY"
                • "STARTS_WITH"
                • "ENDS_WITH"
                • "CONTAINS"
                • "CONTAINS_WORD"
            • SqliMatchStatement — (map)

              Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • XssMatchStatement — (map)

              A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • SizeConstraintStatement — (map)

              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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

              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.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • ComparisonOperatorrequired — (String)

                The operator to use to compare the request part to the size setting.

                Possible values include:
                • "EQ"
                • "NE"
                • "LE"
                • "LT"
                • "GE"
                • "GT"
              • Sizerequired — (Integer)

                The size, in byte, to compare to the request part, after any transformations.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • GeoMatchStatement — (map)

              A rule statement used to identify web requests based on country of origin.

              • CountryCodes — (Array<String>)

                An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

              • ForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • RuleGroupReferenceStatement — (map)

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • IPSetReferenceStatement — (map)

              A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

              Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the IPSet that this statement references.

              • IPSetForwardedIPConfig — (map)

                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.
                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
                • Positionrequired — (String)

                  The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

                  The options for this setting are the following:

                  • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

                  • LAST - Inspect the last IP address in the list of IP addresses in the header.

                  • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

                  Possible values include:
                  • "FIRST"
                  • "LAST"
                  • "ANY"
            • RegexPatternSetReferenceStatement — (map)

              A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

              Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

              • FieldToMatchrequired — (map)

                The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

                • SingleHeader — (map)

                  Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

                  • Namerequired — (String)

                    The name of the query header to inspect.

                • SingleQueryArgument — (map)

                  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.

                  This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

                  • Namerequired — (String)

                    The name of the query argument to inspect.

                • AllQueryArguments — (map)

                  Inspect all query arguments.

                • UriPath — (map)

                  Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

                • QueryString — (map)

                  Inspect the query string. This is the part of a URL that appears after a ? character, if any.

                • Body — (map)

                  Inspect the request body, which 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.

                  Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

                • Method — (map)

                  Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

              • TextTransformationsrequired — (Array<map>)

                Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

                • Priorityrequired — (Integer)

                  Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

                • Typerequired — (String)

                  You can specify the following transformation types:

                  CMD_LINE

                  When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

                  • Delete the following characters: \ " ' ^

                  • Delete spaces before the following characters: / (

                  • Replace the following characters with a space: , ;

                  • Replace multiple spaces with one space

                  • Convert uppercase letters (A-Z) to lowercase (a-z)

                  COMPRESS_WHITE_SPACE

                  Use this option to replace the following characters with a space character (decimal 32):

                  • \f, formfeed, decimal 12

                  • \t, tab, decimal 9

                  • \n, newline, decimal 10

                  • \r, carriage return, decimal 13

                  • \v, vertical tab, decimal 11

                  • non-breaking space, decimal 160

                  COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

                  HTML_ENTITY_DECODE

                  Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

                  • Replaces (ampersand)quot; with "

                  • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

                  • Replaces (ampersand)lt; with a "less than" symbol

                  • Replaces (ampersand)gt; with >

                  • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

                  • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

                  LOWERCASE

                  Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

                  URL_DECODE

                  Use this option to decode a URL-encoded value.

                  NONE

                  Specify NONE if you don't want any text transformations.

                  Possible values include:
                  • "NONE"
                  • "COMPRESS_WHITE_SPACE"
                  • "HTML_ENTITY_DECODE"
                  • "LOWERCASE"
                  • "CMD_LINE"
                  • "URL_DECODE"
            • RateBasedStatement — (map)

              A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

              When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

              You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

              • An IP match statement with an IP set that specified the address 192.0.2.44.

              • A string match statement that searches in the User-Agent header for the string BadBot.

              In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

              You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • Limitrequired — (Integer)

                The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

              • AggregateKeyTyperequired — (String)

                Setting that indicates how to aggregate the request counts. The options are the following:

                • IP - Aggregate the request counts on the IP address from the web request origin.

                • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

                Possible values include:
                • "IP"
                • "FORWARDED_IP"
              • ForwardedIPConfig — (map)

                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 is required if AggregateKeyType is set to FORWARDED_IP.

                • HeaderNamerequired — (String)

                  The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

                  Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
                • FallbackBehaviorrequired — (String)

                  The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

                  Possible values include:
                  • "MATCH"
                  • "NO_MATCH"
            • AndStatement — (map)

              A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with AND logic. You can use any statements that can be nested.

            • OrStatement — (map)

              A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

              • Statementsrequired — (Array<map>)

                The statements to combine with OR logic. You can use any statements that can be nested.

            • NotStatement — (map)

              A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

            • ManagedRuleGroupStatement — (map)

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • Action — (map)

            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.

            • Block — (map)

              Instructs AWS WAF to block the web request.

            • Allow — (map)

              Instructs AWS WAF to allow the web request.

            • Count — (map)

              Instructs AWS WAF to count the web request and allow it.

          • OverrideAction — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • VisibilityConfigrequired — (map)

          Defines and enables Amazon CloudWatch metrics and web request sample collection.

          • SampledRequestsEnabledrequired — (Boolean)

            A boolean indicating 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.

          • CloudWatchMetricsEnabledrequired — (Boolean)

            A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

          • MetricNamerequired — (String)

            A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • Capacity — (Integer)

          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. The WCU limit for web ACLs is 1,500.

        • PreProcessFirewallManagerRuleGroups — (Array<map>)

          The first set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.

          In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

          • Namerequired — (String)

            The name of the rule group. You cannot change the name of a rule group after you create it.

          • Priorityrequired — (Integer)

            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.

          • FirewallManagerStatementrequired — (map)

            The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

            • ManagedRuleGroupStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • RuleGroupReferenceStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • OverrideActionrequired — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)
            Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • PostProcessFirewallManagerRuleGroups — (Array<map>)

          The last set of rules for AWS WAF to process in the web ACL. This is defined in an AWS Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.

          In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.

          • Namerequired — (String)

            The name of the rule group. You cannot change the name of a rule group after you create it.

          • Priorityrequired — (Integer)

            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.

          • FirewallManagerStatementrequired — (map)

            The processing guidance for an AWS Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.

            • ManagedRuleGroupStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

              You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • VendorNamerequired — (String)

                The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

              • Namerequired — (String)

                The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

              • ExcludedRules — (Array<map>)

                The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

                • Namerequired — (String)

                  The name of the rule to exclude.

            • RuleGroupReferenceStatement — (map)
              Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

              A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

              You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

              • ARNrequired — (String)

                The Amazon Resource Name (ARN) of the entity.

              • ExcludedRules — (Array<map>)

                The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

                • Namerequired — (String)

                  The name of the rule to exclude.

          • OverrideActionrequired — (map)

            The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

            Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

            In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

            • If the rule statement references a rule group, use this override action setting and not the action setting.

            • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

            • Count — (map)

              Override the rule action setting to count.

            • None — (map)

              Don't override the rule action setting.

          • VisibilityConfigrequired — (map)
            Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

            Defines and enables Amazon CloudWatch metrics and web request sample collection.

            • SampledRequestsEnabledrequired — (Boolean)

              A boolean indicating 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.

            • CloudWatchMetricsEnabledrequired — (Boolean)

              A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

            • MetricNamerequired — (String)

              A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

        • ManagedByFirewallManager — (Boolean)

          Indicates whether this web ACL is managed by AWS Firewall Manager. If true, then only AWS Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listAvailableManagedRuleGroups(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of managed rule groups that are available for you to use. This list includes all AWS Managed Rules rule groups and the AWS Marketplace managed rule groups that you're subscribed to.

Service Reference:

Examples:

Calling the listAvailableManagedRuleGroups operation

var params = {
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listAvailableManagedRuleGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • ManagedRuleGroups — (Array<map>)

        • VendorName — (String)

          The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

        • Name — (String)

          The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

        • Description — (String)

          The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listIPSets(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of IPSetSummary objects for the IP sets that you manage.

Service Reference:

Examples:

Calling the listIPSets operation

var params = {
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listIPSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • IPSets — (Array<map>)

        Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit specification for this request.

        • Name — (String)

          The name of the IP set. You cannot change the name of an IPSet after you create it.

        • Id — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listLoggingConfigurations(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of your LoggingConfiguration objects.

Service Reference:

Examples:

Calling the listLoggingConfigurations operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE',
  Scope: CLOUDFRONT | REGIONAL
};
wafv2.listLoggingConfigurations(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingConfigurations — (Array<map>)

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

        • LogDestinationConfigsrequired — (Array<String>)

          The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

        • RedactedFields — (Array<map>)

          The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

          Note: You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
          • SingleHeader — (map)

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

            • Namerequired — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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.

            This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

            • Namerequired — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            Inspect the request body, which 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.

            Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

        • ManagedByFirewallManager — (Boolean)

          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.

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRegexPatternSets(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of RegexPatternSetSummary objects for the regex pattern sets that you manage.

Service Reference:

Examples:

Calling the listRegexPatternSets operation

var params = {
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listRegexPatternSets(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • RegexPatternSets — (Array<map>)

        • Name — (String)

          The name of the data type instance. You cannot change the name after you create the instance.

        • Id — (String)

          A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the set that helps with identification. You cannot change the description of a set after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listResourcesForWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of the Amazon Resource Names (ARNs) for the regional resources that are associated with the specified web ACL. If you want the list of AWS CloudFront resources, use the AWS CloudFront call ListDistributionsByWebACLId.

Service Reference:

Examples:

Calling the listResourcesForWebACL operation

var params = {
  WebACLArn: 'STRING_VALUE', /* required */
  ResourceType: APPLICATION_LOAD_BALANCER | API_GATEWAY | APPSYNC
};
wafv2.listResourcesForWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • WebACLArn — (String)

      The Amazon Resource Name (ARN) of the Web ACL.

    • ResourceType — (String)

      Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      Possible values include:
      • "APPLICATION_LOAD_BALANCER"
      • "API_GATEWAY"
      • "APPSYNC"

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • ResourceArns — (Array<String>)

        The array of Amazon Resource Names (ARNs) of the associated resources.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listRuleGroups(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of RuleGroupSummary objects for the rule groups that you manage.

Service Reference:

Examples:

Calling the listRuleGroups operation

var params = {
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listRuleGroups(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • RuleGroups — (Array<map>)

        • Name — (String)

          The name of the data type instance. You cannot change the name after you create the instance.

        • Id — (String)

          A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listTagsForResource(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves the TagInfoForResource for the specified resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each 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.

Service Reference:

Examples:

Calling the listTagsForResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listTagsForResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • TagInfoForResource — (map)

        The collection of tagging definitions for the resource.

        • ResourceARN — (String)

          The Amazon Resource Name (ARN) of the resource.

        • TagList — (Array<map>)

          The array of Tag objects defined for the resource.

          • Keyrequired — (String)

            Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

          • Valuerequired — (String)

            Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

listWebACLs(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Retrieves an array of WebACLSummary objects for the web ACLs that you manage.

Service Reference:

Examples:

Calling the listWebACLs operation

var params = {
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
wafv2.listWebACLs(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • NextMarker — (String)

      When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

    • Limit — (Integer)

      The maximum number of objects that you want AWS WAF to return for this request. If more objects are available, in the response, AWS WAF provides a NextMarker value that you can use in a subsequent call to get the next batch of objects.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextMarker — (String)

        When you request a list of objects with a Limit setting, if the number of objects that are still available for retrieval exceeds the limit, AWS WAF returns a NextMarker value in the response. To retrieve the next batch of objects, provide the marker from the prior call in your next request.

      • WebACLs — (Array<map>)

        • Name — (String)

          The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

        • Id — (String)

          The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

        • Description — (String)

          A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

        • LockToken — (String)

          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.

        • ARN — (String)

          The Amazon Resource Name (ARN) of the entity.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putLoggingConfiguration(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Enables the specified LoggingConfiguration, to start logging from a web ACL, according to the configuration provided.

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

  1. Create an Amazon Kinesis Data Firehose.

    Create the data firehose with a PUT source and in the Region that you are operating. If you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

    Give the data firehose a name that starts with the prefix aws-waf-logs-. For example, aws-waf-logs-us-east-2-analytics.

    Note: Do not create the data firehose using a Kinesis stream as your source.
  2. Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the putLoggingConfiguration operation

var params = {
  LoggingConfiguration: { /* required */
    LogDestinationConfigs: [ /* required */
      'STRING_VALUE',
      /* more items */
    ],
    ResourceArn: 'STRING_VALUE', /* required */
    ManagedByFirewallManager: true || false,
    RedactedFields: [
      {
        AllQueryArguments: {
        },
        Body: {
        },
        Method: {
        },
        QueryString: {
        },
        SingleHeader: {
          Name: 'STRING_VALUE' /* required */
        },
        SingleQueryArgument: {
          Name: 'STRING_VALUE' /* required */
        },
        UriPath: {
        }
      },
      /* more items */
    ]
  }
};
wafv2.putLoggingConfiguration(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • LoggingConfiguration — (map)

      • ResourceArnrequired — (String)

        The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

      • LogDestinationConfigsrequired — (Array<String>)

        The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

      • RedactedFields — (Array<map>)

        The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

        Note: You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
        • SingleHeader — (map)

          Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

          • Namerequired — (String)

            The name of the query header to inspect.

        • SingleQueryArgument — (map)

          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.

          This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

          • Namerequired — (String)

            The name of the query argument to inspect.

        • AllQueryArguments — (map)

          Inspect all query arguments.

        • UriPath — (map)

          Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

        • QueryString — (map)

          Inspect the query string. This is the part of a URL that appears after a ? character, if any.

        • Body — (map)

          Inspect the request body, which 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.

          Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

        • Method — (map)

          Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

      • ManagedByFirewallManager — (Boolean)

        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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • LoggingConfiguration — (map)

        • ResourceArnrequired — (String)

          The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.

        • LogDestinationConfigsrequired — (Array<String>)

          The Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the web ACL.

        • RedactedFields — (Array<map>)

          The parts of the request that you want to keep out of the logs. For example, if you redact the HEADER field, the HEADER field in the firehose will be xxx.

          Note: You must use one of the following values: URI, QUERY_STRING, HEADER, or METHOD.
          • SingleHeader — (map)

            Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

            • Namerequired — (String)

              The name of the query header to inspect.

          • SingleQueryArgument — (map)

            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.

            This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

            • Namerequired — (String)

              The name of the query argument to inspect.

          • AllQueryArguments — (map)

            Inspect all query arguments.

          • UriPath — (map)

            Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

          • QueryString — (map)

            Inspect the query string. This is the part of a URL that appears after a ? character, if any.

          • Body — (map)

            Inspect the request body, which 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.

            Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

          • Method — (map)

            Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

        • ManagedByFirewallManager — (Boolean)

          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.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

putPermissionPolicy(params = {}, callback) ⇒ AWS.Request

Attaches an IAM policy to the specified resource. Use this to share a rule group across accounts.

You must be the owner of the rule group to perform this operation.

This action is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.

  • The ARN in the request must be a valid WAF RuleGroup ARN and the rule group must exist in the same region.

  • The user making the request must be the owner of the rule group.

Service Reference:

Examples:

Calling the putPermissionPolicy operation

var params = {
  Policy: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
wafv2.putPermissionPolicy(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceArn — (String)

      The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.

    • Policy — (String)

      The policy to attach to the specified rule group.

      The policy specifications must conform to the following:

      • The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.

      • The policy must include specifications for Effect, Action, and Principal.

      • Effect must specify Allow.

      • Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and wafv2:PutFirewallManagerRuleGroups. AWS WAF rejects any extra actions or wildcard actions in the policy.

      • The policy must not include a Resource parameter.

      For more information, see IAM Policies.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

tagResource(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each 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.

Service Reference:

Examples:

Calling the tagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  Tags: [ /* required */
    {
      Key: 'STRING_VALUE', /* required */
      Value: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
wafv2.tagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the resource.

    • Tags — (Array<map>)

      An array of key:value pairs to associate with the resource.

      • Keyrequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.

      • Valuerequired — (String)

        Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

untagResource(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Disassociates tags from an AWS resource. Tags are key:value pairs that you can associate with AWS resources. For example, the tag key might be "customer" and the tag value might be "companyA." You can specify one or more tags to add to each container. You can add up to 50 tags to each AWS resource.

Service Reference:

Examples:

Calling the untagResource operation

var params = {
  ResourceARN: 'STRING_VALUE', /* required */
  TagKeys: [ /* required */
    'STRING_VALUE',
    /* more items */
  ]
};
wafv2.untagResource(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • ResourceARN — (String)

      The Amazon Resource Name (ARN) of the resource.

    • TagKeys — (Array<String>)

      An array of keys identifying the tags to disassociate from the resource.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateIPSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Updates the specified IPSet.

Service Reference:

Examples:

Calling the updateIPSet operation

var params = {
  Addresses: [ /* required */
    'STRING_VALUE',
    /* more items */
  ],
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE'
};
wafv2.updateIPSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the IP set. You cannot change the name of an IPSet after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • Description — (String)

      A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

    • Addresses — (Array<String>)

      Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.

      Examples:

      • To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.

      • To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.

      • To configure AWS WAF to allow, block, or count 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.

      • To configure AWS WAF to allow, block, or count 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.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextLockToken — (String)

        A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRegexPatternSet(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Updates the specified RegexPatternSet.

Service Reference:

Examples:

Calling the updateRegexPatternSet operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RegularExpressionList: [ /* required */
    {
      RegexString: 'STRING_VALUE'
    },
    /* more items */
  ],
  Scope: CLOUDFRONT | REGIONAL, /* required */
  Description: 'STRING_VALUE'
};
wafv2.updateRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the set. You cannot change the name after you create the set.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • Description — (String)

      A description of the set that helps with identification. You cannot change the description of a set after you create it.

    • RegularExpressionList — (Array<map>)

      • RegexString — (String)

        The string representing the regular expression.

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextLockToken — (String)

        A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateRuleGroup(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Updates the specified RuleGroup.

A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.

Service Reference:

Examples:

Calling the updateRuleGroup operation

var params = {
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VisibilityConfig: { /* required */
    CloudWatchMetricsEnabled: true || false, /* required */
    MetricName: 'STRING_VALUE', /* required */
    SampledRequestsEnabled: true || false /* required */
  },
  Description: 'STRING_VALUE',
  Rules: [
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            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,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
        },
        Block: {
        },
        Count: {
        }
      },
      OverrideAction: {
        Count: {
        },
        None: {
        }
      }
    },
    /* more items */
  ]
};
wafv2.updateRuleGroup(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the rule group. You cannot change the name of a rule group after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • Description — (String)

      A description of the rule group that helps with identification. You cannot change the description of a rule group after you create it.

    • Rules — (Array<map>)

      The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

      • Namerequired — (String)

        The name of the rule. You can't change the name of a Rule after you create it.

      • Priorityrequired — (Integer)

        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.

      • Statementrequired — (map)

        The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

        • ByteMatchStatement — (map)

          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 refered to as a string match statement.

          • SearchStringrequired — (Buffer, Typed Array, Blob, String)

            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. The maximum length of the value is 50 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.

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

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
          • PositionalConstraintrequired — (String)

            The area within the portion of a 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_WORD

            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 ). In addition, SearchString must be a word, which means that both of the following are true:

            • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

            • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

            EXACTLY

            The value of the specified part of the web request must exactly match the value of SearchString.

            STARTS_WITH

            The value of SearchString must appear at the beginning of the specified part of the web request.

            ENDS_WITH

            The value of SearchString must appear at the end of the specified part of the web request.

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
        • SqliMatchStatement — (map)

          Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • XssMatchStatement — (map)

          A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • SizeConstraintStatement — (map)

          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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

          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.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • ComparisonOperatorrequired — (String)

            The operator to use to compare the request part to the size setting.

            Possible values include:
            • "EQ"
            • "NE"
            • "LE"
            • "LT"
            • "GE"
            • "GT"
          • Sizerequired — (Integer)

            The size, in byte, to compare to the request part, after any transformations.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • GeoMatchStatement — (map)

          A rule statement used to identify web requests based on country of origin.

          • CountryCodes — (Array<String>)

            An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • ForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • RuleGroupReferenceStatement — (map)

          A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

          You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the entity.

          • ExcludedRules — (Array<map>)

            The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

            • Namerequired — (String)

              The name of the rule to exclude.

        • IPSetReferenceStatement — (map)

          A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

          Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the IPSet that this statement references.

          • IPSetForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
            • Positionrequired — (String)

              The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

              The options for this setting are the following:

              • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

              • LAST - Inspect the last IP address in the list of IP addresses in the header.

              • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

              Possible values include:
              • "FIRST"
              • "LAST"
              • "ANY"
        • RegexPatternSetReferenceStatement — (map)

          A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

          Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • RateBasedStatement — (map)

          A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

          When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

          You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

          • An IP match statement with an IP set that specified the address 192.0.2.44.

          • A string match statement that searches in the User-Agent header for the string BadBot.

          In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

          You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • Limitrequired — (Integer)

            The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

          • AggregateKeyTyperequired — (String)

            Setting that indicates how to aggregate the request counts. The options are the following:

            • IP - Aggregate the request counts on the IP address from the web request origin.

            • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

            Possible values include:
            • "IP"
            • "FORWARDED_IP"
          • ForwardedIPConfig — (map)

            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 is required if AggregateKeyType is set to FORWARDED_IP.

            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • AndStatement — (map)

          A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with AND logic. You can use any statements that can be nested.

        • OrStatement — (map)

          A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with OR logic. You can use any statements that can be nested.

        • NotStatement — (map)

          A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

        • ManagedRuleGroupStatement — (map)

          A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

          You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • VendorNamerequired — (String)

            The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

          • Namerequired — (String)

            The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

          • ExcludedRules — (Array<map>)

            The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

            • Namerequired — (String)

              The name of the rule to exclude.

      • Action — (map)

        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.

        • Block — (map)

          Instructs AWS WAF to block the web request.

        • Allow — (map)

          Instructs AWS WAF to allow the web request.

        • Count — (map)

          Instructs AWS WAF to count the web request and allow it.

      • OverrideAction — (map)

        The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

        Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

        In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

        • If the rule statement references a rule group, use this override action setting and not the action setting.

        • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

        • Count — (map)

          Override the rule action setting to count.

        • None — (map)

          Don't override the rule action setting.

      • VisibilityConfigrequired — (map)

        Defines and enables Amazon CloudWatch metrics and web request sample collection.

        • SampledRequestsEnabledrequired — (Boolean)

          A boolean indicating 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.

        • CloudWatchMetricsEnabledrequired — (Boolean)

          A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

        • MetricNamerequired — (String)

          A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • VisibilityConfig — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabledrequired — (Boolean)

        A boolean indicating 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.

      • CloudWatchMetricsEnabledrequired — (Boolean)

        A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

      • MetricNamerequired — (String)

        A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextLockToken — (String)

        A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.

updateWebACL(params = {}, callback) ⇒ AWS.Request

Note: This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

Updates the specified WebACL.

A Web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the Web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a Web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a Web ACL with one or more AWS resources to protect. The resources can be Amazon CloudFront, an Amazon API Gateway REST API, an Application Load Balancer, or an AWS AppSync GraphQL API.

Service Reference:

Examples:

Calling the updateWebACL operation

var params = {
  DefaultAction: { /* required */
    Allow: {
    },
    Block: {
    }
  },
  Id: 'STRING_VALUE', /* required */
  LockToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  Scope: CLOUDFRONT | REGIONAL, /* required */
  VisibilityConfig: { /* required */
    CloudWatchMetricsEnabled: true || false, /* required */
    MetricName: 'STRING_VALUE', /* required */
    SampledRequestsEnabled: true || false /* required */
  },
  Description: 'STRING_VALUE',
  Rules: [
    {
      Name: 'STRING_VALUE', /* required */
      Priority: 'NUMBER_VALUE', /* required */
      Statement: { /* Statement */ /* required */
        AndStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        ByteMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
          SearchString: Buffer.from('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        GeoMatchStatement: {
          CountryCodes: [
            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,
            /* more items */
          ],
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          }
        },
        IPSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          IPSetForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE', /* required */
            Position: FIRST | LAST | ANY /* required */
          }
        },
        ManagedRuleGroupStatement: {
          Name: 'STRING_VALUE', /* required */
          VendorName: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        NotStatement: {
          Statement: /* recursive Statement */
        },
        OrStatement: {
          Statements: [ /* required */
            /* recursive Statement */,
            /* more items */
          ]
        },
        RateBasedStatement: {
          AggregateKeyType: IP | FORWARDED_IP, /* required */
          Limit: 'NUMBER_VALUE', /* required */
          ForwardedIPConfig: {
            FallbackBehavior: MATCH | NO_MATCH, /* required */
            HeaderName: 'STRING_VALUE' /* required */
          },
          ScopeDownStatement: /* recursive Statement */
        },
        RegexPatternSetReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        RuleGroupReferenceStatement: {
          ARN: 'STRING_VALUE', /* required */
          ExcludedRules: [
            {
              Name: 'STRING_VALUE' /* required */
            },
            /* more items */
          ]
        },
        SizeConstraintStatement: {
          ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          Size: 'NUMBER_VALUE', /* required */
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        SqliMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        },
        XssMatchStatement: {
          FieldToMatch: { /* required */
            AllQueryArguments: {
            },
            Body: {
            },
            Method: {
            },
            QueryString: {
            },
            SingleHeader: {
              Name: 'STRING_VALUE' /* required */
            },
            SingleQueryArgument: {
              Name: 'STRING_VALUE' /* required */
            },
            UriPath: {
            }
          },
          TextTransformations: [ /* required */
            {
              Priority: 'NUMBER_VALUE', /* required */
              Type: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
            },
            /* more items */
          ]
        }
      },
      VisibilityConfig: { /* required */
        CloudWatchMetricsEnabled: true || false, /* required */
        MetricName: 'STRING_VALUE', /* required */
        SampledRequestsEnabled: true || false /* required */
      },
      Action: {
        Allow: {
        },
        Block: {
        },
        Count: {
        }
      },
      OverrideAction: {
        Count: {
        },
        None: {
        }
      }
    },
    /* more items */
  ]
};
wafv2.updateWebACL(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

  • params (Object) (defaults to: {})
    • Name — (String)

      The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

    • Scope — (String)

      Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an API Gateway REST API, or an AppSync GraphQL API.

      To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:

      • CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.

      • API and SDKs - For all calls, use the Region endpoint us-east-1.

      Possible values include:
      • "CLOUDFRONT"
      • "REGIONAL"
    • Id — (String)

      The unique identifier for the Web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

    • DefaultAction — (map)

      The action to perform if none of the Rules contained in the WebACL match.

      • Block — (map)

        Specifies that AWS WAF should block requests by default.

      • Allow — (map)

        Specifies that AWS WAF should allow requests by default.

    • Description — (String)

      A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

    • Rules — (Array<map>)

      The Rule statements used to identify the web requests that you want to allow, block, or count. 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.

      • Namerequired — (String)

        The name of the rule. You can't change the name of a Rule after you create it.

      • Priorityrequired — (Integer)

        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.

      • Statementrequired — (map)

        The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.

        • ByteMatchStatement — (map)

          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 refered to as a string match statement.

          • SearchStringrequired — (Buffer, Typed Array, Blob, String)

            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. The maximum length of the value is 50 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.

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

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
          • PositionalConstraintrequired — (String)

            The area within the portion of a 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_WORD

            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 ). In addition, SearchString must be a word, which means that both of the following are true:

            • SearchString is at the beginning of the specified part of the web request or is preceded by a character other than an alphanumeric character or underscore (). Examples include the value of a header and ;BadBot.

            • SearchString is at the end of the specified part of the web request or is followed by a character other than an alphanumeric character or underscore (_), for example, BadBot; and -BadBot;.

            EXACTLY

            The value of the specified part of the web request must exactly match the value of SearchString.

            STARTS_WITH

            The value of SearchString must appear at the beginning of the specified part of the web request.

            ENDS_WITH

            The value of SearchString must appear at the end of the specified part of the web request.

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
        • SqliMatchStatement — (map)

          Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • XssMatchStatement — (map)

          A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • SizeConstraintStatement — (map)

          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 first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and block requests that have a request body greater than 8192 bytes.

          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.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • ComparisonOperatorrequired — (String)

            The operator to use to compare the request part to the size setting.

            Possible values include:
            • "EQ"
            • "NE"
            • "LE"
            • "LT"
            • "GE"
            • "GT"
          • Sizerequired — (Integer)

            The size, in byte, to compare to the request part, after any transformations.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • GeoMatchStatement — (map)

          A rule statement used to identify web requests based on country of origin.

          • CountryCodes — (Array<String>)

            An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO codes of the ISO 3166 international standard.

          • ForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • RuleGroupReferenceStatement — (map)

          A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.

          You cannot nest a RuleGroupReferenceStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the entity.

          • ExcludedRules — (Array<map>)

            The names of rules that are in the referenced rule group, but that you want AWS WAF to exclude from processing for this rule statement.

            • Namerequired — (String)

              The name of the rule to exclude.

        • IPSetReferenceStatement — (map)

          A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.

          Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the IPSet that this statement references.

          • IPSetForwardedIPConfig — (map)

            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.
            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
            • Positionrequired — (String)

              The position in the header to search for the IP address. The header can contain IP addresses of the original client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10 where the first IP address identifies the original client and the rest identify proxies that the request went through.

              The options for this setting are the following:

              • FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.

              • LAST - Inspect the last IP address in the list of IP addresses in the header.

              • ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, AWS WAF inspects the last 10.

              Possible values include:
              • "FIRST"
              • "LAST"
              • "ANY"
        • RegexPatternSetReferenceStatement — (map)

          A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.

          Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, AWS WAF automatically updates all rules that reference it.

          • ARNrequired — (String)

            The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.

          • FieldToMatchrequired — (map)

            The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.

            • SingleHeader — (map)

              Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or Referer. This setting isn't case sensitive.

              • Namerequired — (String)

                The name of the query header to inspect.

            • SingleQueryArgument — (map)

              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.

              This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.

              • Namerequired — (String)

                The name of the query argument to inspect.

            • AllQueryArguments — (map)

              Inspect all query arguments.

            • UriPath — (map)

              Inspect the request URI path. This is the part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • QueryString — (map)

              Inspect the query string. This is the part of a URL that appears after a ? character, if any.

            • Body — (map)

              Inspect the request body, which 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.

              Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.

            • Method — (map)

              Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.

          • TextTransformationsrequired — (Array<map>)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass detection. If you specify one or more transformations in a rule statement, AWS WAF performs all transformations on the content of the request component identified by FieldToMatch, starting from the lowest priority setting, before inspecting the content for a match.

            • Priorityrequired — (Integer)

              Sets the relative processing order for multiple transformations that are defined for a rule statement. 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.

            • Typerequired — (String)

              You can specify the following transformation types:

              CMD_LINE

              When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:

              • Delete the following characters: \ " ' ^

              • Delete spaces before the following characters: / (

              • Replace the following characters with a space: , ;

              • Replace multiple spaces with one space

              • Convert uppercase letters (A-Z) to lowercase (a-z)

              COMPRESS_WHITE_SPACE

              Use this option to replace the following characters with a space character (decimal 32):

              • \f, formfeed, decimal 12

              • \t, tab, decimal 9

              • \n, newline, decimal 10

              • \r, carriage return, decimal 13

              • \v, vertical tab, decimal 11

              • non-breaking space, decimal 160

              COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.

              HTML_ENTITY_DECODE

              Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE performs the following operations:

              • Replaces (ampersand)quot; with "

              • Replaces (ampersand)nbsp; with a non-breaking space, decimal 160

              • Replaces (ampersand)lt; with a "less than" symbol

              • Replaces (ampersand)gt; with >

              • Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the corresponding characters

              • Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the corresponding characters

              LOWERCASE

              Use this option to convert uppercase letters (A-Z) to lowercase (a-z).

              URL_DECODE

              Use this option to decode a URL-encoded value.

              NONE

              Specify NONE if you don't want any text transformations.

              Possible values include:
              • "NONE"
              • "COMPRESS_WHITE_SPACE"
              • "HTML_ENTITY_DECODE"
              • "LOWERCASE"
              • "CMD_LINE"
              • "URL_DECODE"
        • RateBasedStatement — (map)

          A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.

          When the rule action triggers, AWS WAF blocks additional requests from the IP address until the request rate falls below the limit.

          You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:

          • An IP match statement with an IP set that specified the address 192.0.2.44.

          • A string match statement that searches in the User-Agent header for the string BadBot.

          In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.

          You cannot nest a RateBasedStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • Limitrequired — (Integer)

            The limit on requests per 5-minute period for a single originating IP address. If the statement includes a ScopeDownStatement, this limit is applied only to the requests that match the statement.

          • AggregateKeyTyperequired — (String)

            Setting that indicates how to aggregate the request counts. The options are the following:

            • IP - Aggregate the request counts on the IP address from the web request origin.

            • FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure the ForwardedIPConfig, to specify the header to use.

            Possible values include:
            • "IP"
            • "FORWARDED_IP"
          • ForwardedIPConfig — (map)

            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 is required if AggregateKeyType is set to FORWARDED_IP.

            • HeaderNamerequired — (String)

              The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set this to X-Forwarded-For.

              Note: If the specified header isn't present in the request, AWS WAF doesn't apply the rule to the web request at all.
            • FallbackBehaviorrequired — (String)

              The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.

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

              Possible values include:
              • "MATCH"
              • "NO_MATCH"
        • AndStatement — (map)

          A logical rule statement used to combine other rule statements with AND logic. You provide more than one Statement within the AndStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with AND logic. You can use any statements that can be nested.

        • OrStatement — (map)

          A logical rule statement used to combine other rule statements with OR logic. You provide more than one Statement within the OrStatement.

          • Statementsrequired — (Array<map>)

            The statements to combine with OR logic. You can use any statements that can be nested.

        • NotStatement — (map)

          A logical rule statement used to negate the results of another rule statement. You provide one Statement within the NotStatement.

        • ManagedRuleGroupStatement — (map)

          A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.

          You can't nest a ManagedRuleGroupStatement, for example for use inside a NotStatement or OrStatement. It can only be referenced as a top-level statement within a rule.

          • VendorNamerequired — (String)

            The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.

          • Namerequired — (String)

            The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.

          • ExcludedRules — (Array<map>)

            The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the rule. This effectively excludes the rule from acting on web requests.

            • Namerequired — (String)

              The name of the rule to exclude.

      • Action — (map)

        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.

        • Block — (map)

          Instructs AWS WAF to block the web request.

        • Allow — (map)

          Instructs AWS WAF to allow the web request.

        • Count — (map)

          Instructs AWS WAF to count the web request and allow it.

      • OverrideAction — (map)

        The override action to apply to the rules in a rule group. Used only for rule statements that reference a rule group, like RuleGroupReferenceStatement and ManagedRuleGroupStatement.

        Set the override action to none to leave the rule actions in effect. Set it to count to only count matches, regardless of the rule action settings.

        In a Rule, you must specify either this OverrideAction setting or the rule Action setting, but not both:

        • If the rule statement references a rule group, use this override action setting and not the action setting.

        • If the rule statement does not reference a rule group, use the rule action setting and not this rule override action setting.

        • Count — (map)

          Override the rule action setting to count.

        • None — (map)

          Don't override the rule action setting.

      • VisibilityConfigrequired — (map)

        Defines and enables Amazon CloudWatch metrics and web request sample collection.

        • SampledRequestsEnabledrequired — (Boolean)

          A boolean indicating 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.

        • CloudWatchMetricsEnabledrequired — (Boolean)

          A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

        • MetricNamerequired — (String)

          A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • VisibilityConfig — (map)

      Defines and enables Amazon CloudWatch metrics and web request sample collection.

      • SampledRequestsEnabledrequired — (Boolean)

        A boolean indicating 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.

      • CloudWatchMetricsEnabledrequired — (Boolean)

        A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.

      • MetricNamerequired — (String)

        A name of the CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and _ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names reserved for AWS WAF, for example "All" and "Default_Action."

    • LockToken — (String)

      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.

Callback (callback):

  • function(err, data) { ... }

    Called when a response from the service is returned. If a callback is not supplied, you must call AWS.Request.send() on the returned request object to initiate the request.

    Context (this):

    • (AWS.Response)

      the response object containing error, data properties, and the original request object.

    Parameters:

    • err (Error)

      the error object returned from the request. Set to null if the request is successful.

    • data (Object)

      the de-serialized data returned from the request. Set to null if a request error occurs. The data object has the following properties:

      • NextLockToken — (String)

        A token used for optimistic locking. AWS WAF returns this token to your update requests. You use NextLockToken in the same manner as you use LockToken.

Returns:

  • (AWS.Request)

    a handle to the operation request for subsequent event callback registration.