Class: AWS.WAF

Inherits:
AWS.Service show all
Identifier:
waf
API Version:
2015-08-24
Defined in:
(unknown)

Overview

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

Service Description

This is the AWS WAF API Reference for using AWS WAF with Amazon CloudFront. The AWS WAF actions and data types listed in the reference are available for protecting Amazon CloudFront distributions. You can use these actions and data types via the endpoint waf.amazonaws.com. This guide is for developers who need detailed information about the AWS WAF API actions, data types, and errors. For detailed information about AWS WAF features and an overview of how to use the AWS WAF API, see the AWS WAF Developer Guide.

Sending a Request Using WAF

var waf = new AWS.WAF();
waf.createByteMatchSet(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 WAF object uses this specific API, you can construct the object by passing the apiVersion option to the constructor:

var waf = new AWS.WAF({apiVersion: '2015-08-24'});

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

AWS.config.apiVersions = {
  waf: '2015-08-24',
  // other service API versions
};

var waf = new AWS.WAF();

Version:

  • 2015-08-24

Constructor Summary

Property Summary

Properties inherited from AWS.Service

apiVersions

Method Summary

Methods inherited from AWS.Service

makeRequest, makeUnauthenticatedRequest, waitFor, setupRequestListeners, defineService

Constructor Details

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

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

Examples:

Constructing a WAF object

var waf = new AWS.WAF({apiVersion: '2015-08-24'});

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) —

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

  • 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.WAF.region for more information.

  • maxRetries (Integer) —

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

  • maxRedirects (Integer) —

    the maximum amount of redirects to follow with a request. See AWS.WAF.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.

  • 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 returns the amount of time to delay in milliseconds. The base option will be ignored if this option is supplied.
  • 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) —

    whether to enable endpoint discovery for operations that allow optionally using an endpoint returned by the service. Defaults to 'false'

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

Property Details

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

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

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

  2. Submit a CreateByteMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  4. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createByteMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createByteMatchSet(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)

      A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ByteMatchSet — (map)

        A ByteMatchSet that contains no ByteMatchTuple objects.

        • ByteMatchSetId — required — (String)

          The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

          ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

        • Name — (String)

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

        • ByteMatchTuples — required — (Array<map>)

          Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

          • FieldToMatch — required — (map)

            The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TargetString — required — (Buffer, Typed Array, Blob, String)

            The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

            Valid values depend on the values that you specified for FieldToMatch:

            • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

            • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

            • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

            If TargetString 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 TargetString.

            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.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

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

            Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

            CONTAINS

            The specified part of the web request must include the value of TargetString, but the location doesn't matter.

            CONTAINS_WORD

            The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or ). In addition, TargetString must be a word, which means one of the following:

            • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

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

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

            • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (), for example, -BadBot;.

            EXACTLY

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

            STARTS_WITH

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

            ENDS_WITH

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

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"
      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

To create and configure a GeoMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request.

  2. Submit a CreateGeoMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

  4. Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createGeoMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createGeoMatchSet(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)

      A friendly name or description of the GeoMatchSet. You can't change Name after you create the GeoMatchSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • GeoMatchSet — (map)

        The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet contains no GeoMatchConstraints.

        • GeoMatchSetId — required — (String)

          The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet).

          GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

        • Name — (String)

          A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

        • GeoMatchConstraints — required — (Array<map>)

          An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

          • Type — required — (String)

            The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

            Possible values include:
            • "Country"
          • Value — required — (String)

            The country that you want AWS WAF to search for.

            Possible values include:
            • "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"
      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

  2. Submit a CreateIPSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  4. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create an IP set


/* The following example creates an IP match set named MyIPSetFriendlyName. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Name: "MyIPSetFriendlyName"
 };
 waf.createIPSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    IPSet: {
     IPSetDescriptors: [
        {
       Type: "IPV4", 
       Value: "192.0.2.44/32"
      }
     ], 
     IPSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     Name: "MyIPSetFriendlyName"
    }
   }
   */
 });

Calling the createIPSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.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)

      A friendly name or description of the IPSet. You can't change Name after you create the IPSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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)

        The IPSet returned in the CreateIPSet response.

        • IPSetId — required — (String)

          The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

          IPSetId is returned by CreateIPSet and by ListIPSets.

        • Name — (String)

          A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

        • IPSetDescriptors — required — (Array<map>)

          The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

          • Type — required — (String)

            Specify IPV4 or IPV6.

            Possible values include:
            • "IPV4"
            • "IPV6"
          • Value — required — (String)

            Specify an IPv4 address by using CIDR notation. For example:

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

            For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

            Specify an IPv6 address by using CIDR notation. For example:

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

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the specifications to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

  • An IPSet that matches the IP address 192.0.2.44/32

  • A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 15,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 15,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 15,000 for a five-minute period, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

  • A ByteMatchSet with FieldToMatch of URI

  • A PositionalConstraint of STARTS_WITH

  • A TargetString of login

Further, you specify a RateLimit of 15,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

To create and configure a RateBasedRule, perform the following steps:

  1. Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

  3. Submit a CreateRateBasedRule request.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  5. Submit an UpdateRateBasedRule request to specify the predicates that you want to include in the rule.

  6. Create and update a WebACL that contains the RateBasedRule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createRateBasedRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  MetricName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE', /* required */
  RateKey: IP, /* required */
  RateLimit: 'NUMBER_VALUE' /* required */
};
waf.createRateBasedRule(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)

      A friendly name or description of the RateBasedRule. You can't change the name of a RateBasedRule after you create it.

    • MetricName — (String)

      A friendly name or description for the metrics for this RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

    • RateKey — (String)

      The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests that arrive from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

      Possible values include:
      • "IP"
    • RateLimit — (Integer)

      The maximum number of requests, which have an identical value in the field that is specified by RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

    • ChangeToken — (String)

      The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

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:

      • Rule — (map)

        The RateBasedRule that is returned in the CreateRateBasedRule response.

        • RuleId — required — (String)

          A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

        • Name — (String)

          A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

        • MatchPredicates — required — (Array<map>)

          The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

          • Negated — required — (Boolean)

            Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

            Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

          • Type — required — (String)

            The type of predicate in a Rule, such as ByteMatch or IPSet.

            Possible values include:
            • "IPMatch"
            • "ByteMatch"
            • "SqlInjectionMatch"
            • "GeoMatch"
            • "SizeConstraint"
            • "XssMatch"
            • "RegexMatch"
          • DataId — required — (String)

            A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

        • RateKey — required — (String)

          The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

          Possible values include:
          • "IP"
        • RateLimit — required — (Integer)

          The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.

  2. Submit a CreateRegexMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

  4. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createRegexMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createRegexMatchSet(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)

      A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • RegexMatchSet — (map)

        A RegexMatchSet that contains no RegexMatchTuple objects.

        • RegexMatchSetId — (String)

          The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

          RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

        • Name — (String)

          A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

        • RegexMatchTuples — (Array<map>)

          Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

          • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

          • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

          • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for the RegexPatternSet.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            CMD_LINE

            When you're concerned that attackers are injecting an operating system commandline 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 to perform any text transformations.

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

            The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

            RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexPatternSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

  2. Submit a CreateRegexPatternSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

  4. Submit an UpdateRegexPatternSet request to specify the string that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createRegexPatternSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.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)

      A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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)

        A RegexPatternSet that contains no objects.

        • RegexPatternSetId — required — (String)

          The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

          RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

        • Name — (String)

          A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

        • RegexPatternStrings — required — (Array<String>)

          Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

  • An IPSet that matches the IP address 192.0.2.44/32

  • A ByteMatchSet that matches BadBot in the User-Agent header

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

  3. Submit a CreateRule request.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  5. Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

  6. Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create a rule


/* The following example creates a rule named WAFByteHeaderRule. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  MetricName: "WAFByteHeaderRule", 
  Name: "WAFByteHeaderRule"
 };
 waf.createRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    Rule: {
     MetricName: "WAFByteHeaderRule", 
     Name: "WAFByteHeaderRule", 
     Predicates: [
        {
       DataId: "MyByteMatchSetID", 
       Negated: false, 
       Type: "ByteMatch"
      }
     ], 
     RuleId: "WAFRule-1-Example"
    }
   }
   */
 });

Calling the createRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  MetricName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createRule(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)

      A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

    • MetricName — (String)

      A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change the name of the metric after you create the Rule.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • Rule — (map)

        The Rule returned in the CreateRule response.

        • RuleId — required — (String)

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Name — (String)

          The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule.

        • Predicates — required — (Array<map>)

          The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

          • Negated — required — (Boolean)

            Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

            Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

          • Type — required — (String)

            The type of predicate in a Rule, such as ByteMatch or IPSet.

            Possible values include:
            • "IPMatch"
            • "ByteMatch"
            • "SqlInjectionMatch"
            • "GeoMatch"
            • "SizeConstraint"
            • "XssMatch"
            • "RegexMatch"
          • DataId — required — (String)

            A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a RuleGroup. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.

Rule groups are subject to the following limits:

  • Three rule groups per account. You can request an increase to this limit by contacting customer support.

  • One rule group per web ACL.

  • Ten rules per rule group.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the createRuleGroup operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  MetricName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.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)

      A friendly name or description of the RuleGroup. You can't change Name after you create a RuleGroup.

    • MetricName — (String)

      A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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)

        An empty RuleGroup.

        • RuleGroupId — required — (String)

          A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

          RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

        • Name — (String)

          The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

  2. Submit a CreateSizeConstraintSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  4. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create a size constraint


/* The following example creates size constraint set named MySampleSizeConstraintSet. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Name: "MySampleSizeConstraintSet"
 };
 waf.createSizeConstraintSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    SizeConstraintSet: {
     Name: "MySampleSizeConstraintSet", 
     SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     SizeConstraints: [
        {
       ComparisonOperator: "GT", 
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       Size: 0, 
       TextTransformation: "NONE"
      }
     ]
    }
   }
   */
 });

Calling the createSizeConstraintSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createSizeConstraintSet(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)

      A friendly name or description of the SizeConstraintSet. You can't change Name after you create a SizeConstraintSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • SizeConstraintSet — (map)

        A SizeConstraintSet that contains no SizeConstraint objects.

        • SizeConstraintSetId — required — (String)

          A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

          SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

        • Name — (String)

          The name, if any, of the SizeConstraintSet.

        • SizeConstraints — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect the size of.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for the size constraint.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

            NONE

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

            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.

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

            The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

            EQ: Used to test if the Size is equal to the size of the FieldToMatch

            NE: Used to test if the Size is not equal to the size of the FieldToMatch

            LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

            LT: Used to test if the Size is strictly less than the size of the FieldToMatch

            GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

            GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

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

            The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

            Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

            If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

  2. Submit a CreateSqlInjectionMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

  4. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create a SQL injection match set


/* The following example creates a SQL injection match set named MySQLInjectionMatchSet. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Name: "MySQLInjectionMatchSet"
 };
 waf.createSqlInjectionMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    SqlInjectionMatchSet: {
     Name: "MySQLInjectionMatchSet", 
     SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     SqlInjectionMatchTuples: [
        {
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       TextTransformation: "URL_DECODE"
      }
     ]
    }
   }
   */
 });

Calling the createSqlInjectionMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createSqlInjectionMatchSet(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)

      A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change Name after you create the SqlInjectionMatchSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • SqlInjectionMatchSet — (map)

        A SqlInjectionMatchSet.

        • SqlInjectionMatchSetId — required — (String)

          A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

          SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

        • Name — (String)

          The name, if any, of the SqlInjectionMatchSet.

        • SqlInjectionMatchTuples — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for snippets of malicious SQL code.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

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

        The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

To create and configure a WebACL, perform the following steps:

  1. Create and update the ByteMatchSet objects and other predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateWebACL request.

  4. Submit a CreateWebACL request.

  5. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  6. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

For more information about how to use the AWS WAF API, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create a web ACL


/* The following example creates a web ACL named CreateExample. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  DefaultAction: {
   Type: "ALLOW"
  }, 
  MetricName: "CreateExample", 
  Name: "CreateExample"
 };
 waf.createWebACL(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    WebACL: {
     DefaultAction: {
      Type: "ALLOW"
     }, 
     MetricName: "CreateExample", 
     Name: "CreateExample", 
     Rules: [
        {
       Action: {
        Type: "ALLOW"
       }, 
       Priority: 1, 
       RuleId: "WAFRule-1-Example"
      }
     ], 
     WebACLId: "example-46da-4444-5555-example"
    }
   }
   */
 });

Calling the createWebACL operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  DefaultAction: { /* required */
    Type: BLOCK | ALLOW | COUNT /* required */
  },
  MetricName: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.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)

      A friendly name or description of the WebACL. You can't change Name after you create the WebACL.

    • MetricName — (String)

      A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain white space. You can't change MetricName after you create the WebACL.

    • DefaultAction — (map)

      The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the Rule objects that are associated with the WebACL.

      • Type — required — (String)

        Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

        • ALLOW: AWS WAF allows requests

        • BLOCK: AWS WAF blocks requests

        • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

        Possible values include:
        • "BLOCK"
        • "ALLOW"
        • "COUNT"
    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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 WebACL returned in the CreateWebACL response.

        • WebACLId — required — (String)

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

        • Name — (String)

          A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

        • DefaultAction — required — (map)

          The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

          • Type — required — (String)

            Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

            • ALLOW: AWS WAF allows requests

            • BLOCK: AWS WAF blocks requests

            • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

            Possible values include:
            • "BLOCK"
            • "ALLOW"
            • "COUNT"
        • Rules — required — (Array<map>)

          An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

          • Priority — required — (Integer)

            Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

          • RuleId — required — (String)

            The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

            RuleId is returned by CreateRule and by ListRules.

          • Action — (map)

            Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

            • ALLOW: CloudFront responds with the requested object.

            • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

            • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

            ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

            • Type — required — (String)

              Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

              • ALLOW: AWS WAF allows requests

              • BLOCK: AWS WAF blocks requests

              • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

              Possible values include:
              • "BLOCK"
              • "ALLOW"
              • "COUNT"
          • OverrideAction — (map)

            Use the OverrideAction to test your RuleGroup.

            Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

            ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

            • Type — required — (String)

              COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

              Possible values include:
              • "NONE"
              • "COUNT"
          • Type — (String)

            The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

            Possible values include:
            • "REGULAR"
            • "RATE_BASED"
            • "GROUP"
          • ExcludedRules — (Array<map>)

            An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

            Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

            Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

            If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

            1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

            2. Submit an UpdateWebACL request that has two actions:

              • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

              • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

            • RuleId — required — (String)

              The unique identifier for the rule to exclude from the rule group.

        • WebACLArn — (String)

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

      • ChangeToken — (String)

        The ChangeToken that you used to submit the CreateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

  1. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

  2. Submit a CreateXssMatchSet request.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

  4. Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To create an XSS match set


/* The following example creates an XSS match set named MySampleXssMatchSet. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Name: "MySampleXssMatchSet"
 };
 waf.createXssMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
    XssMatchSet: {
     Name: "MySampleXssMatchSet", 
     XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     XssMatchTuples: [
        {
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       TextTransformation: "URL_DECODE"
      }
     ]
    }
   }
   */
 });

Calling the createXssMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Name: 'STRING_VALUE' /* required */
};
waf.createXssMatchSet(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)

      A friendly name or description for the XssMatchSet that you're creating. You can't change Name after you create the XssMatchSet.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • XssMatchSet — (map)

        An XssMatchSet.

        • XssMatchSetId — required — (String)

          A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

          XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

        • Name — (String)

          The name, if any, of the XssMatchSet.

        • XssMatchTuples — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for cross-site scripting attacks.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

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

        The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

  1. Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

  3. Submit a DeleteByteMatchSet request.

Service Reference:

Examples:

To delete a byte match set


/* The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ByteMatchSetId: "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", 
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
 };
 waf.deleteByteMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteByteMatchSet operation

var params = {
  ByteMatchSetId: 'STRING_VALUE', /* required */
  ChangeToken: 'STRING_VALUE' /* required */
};
waf.deleteByteMatchSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a GeoMatchSet. You can't delete a GeoMatchSet if it's still used in any Rules or if it still includes any countries.

If you just want to remove a GeoMatchSet from a Rule, use UpdateRule.

To permanently delete a GeoMatchSet from AWS WAF, perform the following steps:

  1. Update the GeoMatchSet to remove any countries. For more information, see UpdateGeoMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteGeoMatchSet request.

  3. Submit a DeleteGeoMatchSet request.

Service Reference:

Examples:

Calling the deleteGeoMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  GeoMatchSetId: 'STRING_VALUE' /* required */
};
waf.deleteGeoMatchSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes an IPSet. You can't delete an IPSet if it's still used in any Rules or if it still includes any IP addresses.

If you just want to remove an IPSet from a Rule, use UpdateRule.

To permanently delete an IPSet from AWS WAF, perform the following steps:

  1. Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

  3. Submit a DeleteIPSet request.

Service Reference:

Examples:

To delete an IP set


/* The following example deletes an IP match set  with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  IPSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.deleteIPSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteIPSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  IPSetId: 'STRING_VALUE' /* required */
};
waf.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: {}) —
    • IPSetId — (String)

      The IPSetId of the IPSet that you want to delete. IPSetId is returned by CreateIPSet and by ListIPSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes the LoggingConfiguration from the specified web ACL.

Service Reference:

Examples:

Calling the deleteLoggingConfiguration operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
waf.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 RuleGroup.

The user making the request must be the owner of the RuleGroup.

Service Reference:

Examples:

Calling the deletePermissionPolicy operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
waf.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 RuleGroup from which you want to delete the policy.

      The user making the request must be the owner of the RuleGroup.

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.

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

Permanently deletes a RateBasedRule. You can't delete a rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a rule from a WebACL, use UpdateWebACL.

To permanently delete a RateBasedRule from AWS WAF, perform the following steps:

  1. Update the RateBasedRule to remove predicates, if any. For more information, see UpdateRateBasedRule.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRateBasedRule request.

  3. Submit a DeleteRateBasedRule request.

Service Reference:

Examples:

Calling the deleteRateBasedRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RuleId: 'STRING_VALUE' /* required */
};
waf.deleteRateBasedRule(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a RegexMatchSet. You can't delete a RegexMatchSet if it's still used in any Rules or if it still includes any RegexMatchTuples objects (any filters).

If you just want to remove a RegexMatchSet from a Rule, use UpdateRule.

To permanently delete a RegexMatchSet, perform the following steps:

  1. Update the RegexMatchSet to remove filters, if any. For more information, see UpdateRegexMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRegexMatchSet request.

  3. Submit a DeleteRegexMatchSet request.

Service Reference:

Examples:

Calling the deleteRegexMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RegexMatchSetId: 'STRING_VALUE' /* required */
};
waf.deleteRegexMatchSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a RegexPatternSet. You can't delete a RegexPatternSet if it's still used in any RegexMatchSet or if the RegexPatternSet is not empty.

Service Reference:

Examples:

Calling the deleteRegexPatternSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RegexPatternSetId: 'STRING_VALUE' /* required */
};
waf.deleteRegexPatternSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

To permanently delete a Rule from AWS WAF, perform the following steps:

  1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

  3. Submit a DeleteRule request.

Service Reference:

Examples:

To delete a rule


/* The following example deletes a rule with the ID WAFRule-1-Example. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  RuleId: "WAFRule-1-Example"
 };
 waf.deleteRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RuleId: 'STRING_VALUE' /* required */
};
waf.deleteRule(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: {}) —
    • RuleId — (String)

      The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a RuleGroup. You can't delete a RuleGroup if it's still used in any WebACL objects or if it still includes any rules.

If you just want to remove a RuleGroup from a WebACL, use UpdateWebACL.

To permanently delete a RuleGroup from AWS WAF, perform the following steps:

  1. Update the RuleGroup to remove rules, if any. For more information, see UpdateRuleGroup.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRuleGroup request.

  3. Submit a DeleteRuleGroup request.

Service Reference:

Examples:

Calling the deleteRuleGroup operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RuleGroupId: 'STRING_VALUE' /* required */
};
waf.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: {}) —

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a SizeConstraintSet. You can't delete a SizeConstraintSet if it's still used in any Rules or if it still includes any SizeConstraint objects (any filters).

If you just want to remove a SizeConstraintSet from a Rule, use UpdateRule.

To permanently delete a SizeConstraintSet, perform the following steps:

  1. Update the SizeConstraintSet to remove filters, if any. For more information, see UpdateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

  3. Submit a DeleteSizeConstraintSet request.

Service Reference:

Examples:

To delete a size constraint set


/* The following example deletes a size constraint set  with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.deleteSizeConstraintSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteSizeConstraintSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  SizeConstraintSetId: 'STRING_VALUE' /* required */
};
waf.deleteSizeConstraintSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a SqlInjectionMatchSet. You can't delete a SqlInjectionMatchSet if it's still used in any Rules or if it still contains any SqlInjectionMatchTuple objects.

If you just want to remove a SqlInjectionMatchSet from a Rule, use UpdateRule.

To permanently delete a SqlInjectionMatchSet from AWS WAF, perform the following steps:

  1. Update the SqlInjectionMatchSet to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

  3. Submit a DeleteSqlInjectionMatchSet request.

Service Reference:

Examples:

To delete a SQL injection match set


/* The following example deletes a SQL injection match set  with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.deleteSqlInjectionMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteSqlInjectionMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  SqlInjectionMatchSetId: 'STRING_VALUE' /* required */
};
waf.deleteSqlInjectionMatchSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

  1. Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

  3. Submit a DeleteWebACL request.

Service Reference:

Examples:

To delete a web ACL


/* The following example deletes a web ACL with the ID example-46da-4444-5555-example. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  WebACLId: "example-46da-4444-5555-example"
 };
 waf.deleteWebACL(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteWebACL operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  WebACLId: 'STRING_VALUE' /* required */
};
waf.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: {}) —
    • WebACLId — (String)

      The WebACLId of the WebACL that you want to delete. WebACLId is returned by CreateWebACL and by ListWebACLs.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

  1. Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

  3. Submit a DeleteXssMatchSet request.

Service Reference:

Examples:

To delete an XSS match set


/* The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.deleteXssMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the deleteXssMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  XssMatchSetId: 'STRING_VALUE' /* required */
};
waf.deleteXssMatchSet(params, function(err, data) {
  if (err) console.log(err, err.stack); // an error occurred
  else     console.log(data);           // successful response
});

Parameters:

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Returns the ByteMatchSet specified by ByteMatchSetId.

Service Reference:

Examples:

To get a byte match set


/* The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ByteMatchSetId: "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getByteMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ByteMatchSet: {
     ByteMatchSetId: "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", 
     ByteMatchTuples: [
        {
       FieldToMatch: {
        Data: "referer", 
        Type: "HEADER"
       }, 
       PositionalConstraint: "CONTAINS", 
       TargetString: <Binary String>, 
       TextTransformation: "NONE"
      }
     ], 
     Name: "ByteMatchNameExample"
    }
   }
   */
 });

Calling the getByteMatchSet operation

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

Parameters:

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:

      • ByteMatchSet — (map)

        Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For more information, see the following topics:

        • ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name

        • ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each ByteMatchTuple object contains FieldToMatch, PositionalConstraint, TargetString, and TextTransformation

        • FieldToMatch: Contains Data and Type

        • ByteMatchSetId — required — (String)

          The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet (see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see DeleteByteMatchSet).

          ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

        • Name — (String)

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

        • ByteMatchTuples — required — (Array<map>)

          Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.

          • FieldToMatch — required — (map)

            The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TargetString — required — (Buffer, Typed Array, Blob, String)

            The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

            Valid values depend on the values that you specified for FieldToMatch:

            • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

            • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

            • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

            If TargetString 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 TargetString.

            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.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

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

            Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

            CONTAINS

            The specified part of the web request must include the value of TargetString, but the location doesn't matter.

            CONTAINS_WORD

            The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or ). In addition, TargetString must be a word, which means one of the following:

            • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

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

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

            • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (), for example, -BadBot;.

            EXACTLY

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

            STARTS_WITH

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

            ENDS_WITH

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

            Possible values include:
            • "EXACTLY"
            • "STARTS_WITH"
            • "ENDS_WITH"
            • "CONTAINS"
            • "CONTAINS_WORD"

Returns:

  • (AWS.Request) —

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

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

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

Service Reference:

Examples:

To get a change token


/* The following example returns a change token to use for a create, update or delete operation. */

 var params = {
 };
 waf.getChangeToken(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the getChangeToken operation

var params = {
};
waf.getChangeToken(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: {})

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:

      • ChangeToken — (String)

        The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus request to get the current status of the request.

Returns:

  • (AWS.Request) —

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

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

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

  • PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

  • PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

  • INSYNC: Propagation is complete.

Service Reference:

Examples:

To get the change token status


/* The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
 };
 waf.getChangeTokenStatus(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeTokenStatus: "PENDING"
   }
   */
 });

Calling the getChangeTokenStatus operation

var params = {
  ChangeToken: 'STRING_VALUE' /* required */
};
waf.getChangeTokenStatus(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: {}) —
    • ChangeToken — (String)

      The change token for which you want to get the status. This change token was previously returned in the GetChangeToken response.

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:

      • ChangeTokenStatus — (String)

        The status of the change token.

        Possible values include:
        • "PROVISIONED"
        • "PENDING"
        • "INSYNC"

Returns:

  • (AWS.Request) —

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

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

Returns the GeoMatchSet that is specified by GeoMatchSetId.

Service Reference:

Examples:

Calling the getGeoMatchSet operation

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

Parameters:

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:

      • GeoMatchSet — (map)

        Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This includes the Type, which for a GeoMatchContraint is always Country, as well as the Value, which is the identifier for a specific country.

        • GeoMatchSetId — required — (String)

          The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see DeleteGeoMatchSet).

          GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

        • Name — (String)

          A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

        • GeoMatchConstraints — required — (Array<map>)

          An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.

          • Type — required — (String)

            The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

            Possible values include:
            • "Country"
          • Value — required — (String)

            The country that you want AWS WAF to search for.

            Possible values include:
            • "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"

Returns:

  • (AWS.Request) —

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

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

Returns the IPSet that is specified by IPSetId.

Service Reference:

Examples:

To get an IP set


/* The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  IPSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getIPSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    IPSet: {
     IPSetDescriptors: [
        {
       Type: "IPV4", 
       Value: "192.0.2.44/32"
      }
     ], 
     IPSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     Name: "MyIPSetFriendlyName"
    }
   }
   */
 });

Calling the getIPSet operation

var params = {
  IPSetId: 'STRING_VALUE' /* required */
};
waf.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: {}) —

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)

        Information about the IPSet that you specified in the GetIPSet request. For more information, see the following topics:

        • IPSet: Contains IPSetDescriptors, IPSetId, and Name

        • IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each IPSetDescriptor object contains Type and Value

        • IPSetId — required — (String)

          The IPSetId for an IPSet. You use IPSetId to get information about an IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an IPSet into a Rule or delete one from a Rule (see UpdateRule), and delete an IPSet from AWS WAF (see DeleteIPSet).

          IPSetId is returned by CreateIPSet and by ListIPSets.

        • Name — (String)

          A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

        • IPSetDescriptors — required — (Array<map>)

          The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the CloudFront access logs.

          • Type — required — (String)

            Specify IPV4 or IPV6.

            Possible values include:
            • "IPV4"
            • "IPV6"
          • Value — required — (String)

            Specify an IPv4 address by using CIDR notation. For example:

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

            For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

            Specify an IPv6 address by using CIDR notation. For example:

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

Returns:

  • (AWS.Request) —

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

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

Returns the LoggingConfiguration for the specified web ACL.

Service Reference:

Examples:

Calling the getLoggingConfiguration operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
waf.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.

        • ResourceArn — required — (String)

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

        • LogDestinationConfigs — required — (Array<String>)

          An array of Amazon Kinesis Data Firehose ARNs.

        • RedactedFields — (Array<map>)

          The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

Returns:

  • (AWS.Request) —

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

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

Returns the IAM policy attached to the RuleGroup.

Service Reference:

Examples:

Calling the getPermissionPolicy operation

var params = {
  ResourceArn: 'STRING_VALUE' /* required */
};
waf.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 RuleGroup 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 attached to the specified RuleGroup.

Returns:

  • (AWS.Request) —

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

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

Returns the RateBasedRule that is specified by the RuleId that you included in the GetRateBasedRule request.

Service Reference:

Examples:

Calling the getRateBasedRule operation

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

Parameters:

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:

      • Rule — (map)

        Information about the RateBasedRule that you specified in the GetRateBasedRule request.

        • RuleId — required — (String)

          A unique identifier for a RateBasedRule. You use RuleId to get more information about a RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see DeleteRateBasedRule).

        • Name — (String)

          A friendly name or description for a RateBasedRule. You can't change the name of a RateBasedRule after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for a RateBasedRule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RateBasedRule.

        • MatchPredicates — required — (Array<map>)

          The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.

          • Negated — required — (Boolean)

            Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

            Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

          • Type — required — (String)

            The type of predicate in a Rule, such as ByteMatch or IPSet.

            Possible values include:
            • "IPMatch"
            • "ByteMatch"
            • "SqlInjectionMatch"
            • "GeoMatch"
            • "SizeConstraint"
            • "XssMatch"
            • "RegexMatch"
          • DataId — required — (String)

            A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

        • RateKey — required — (String)

          The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to rate monitoring. The only valid value for RateKey is IP. IP indicates that requests arriving from the same IP address are subject to the RateLimit that is specified in the RateBasedRule.

          Possible values include:
          • "IP"
        • RateLimit — required — (Integer)

          The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

Returns:

  • (AWS.Request) —

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

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

Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

Service Reference:

Examples:

Calling the getRateBasedRuleManagedKeys operation

var params = {
  RuleId: 'STRING_VALUE', /* required */
  NextMarker: 'STRING_VALUE'
};
waf.getRateBasedRuleManagedKeys(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: {}) —
    • RuleId — (String)

      The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    • NextMarker — (String)

      A null value and not currently used. Do not include this in your request.

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:

      • ManagedKeys — (Array<String>)

        An array of IP addresses that currently are blocked by the specified RateBasedRule.

      • NextMarker — (String)

        A null value and not currently used.

Returns:

  • (AWS.Request) —

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

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

Returns the RegexMatchSet specified by RegexMatchSetId.

Service Reference:

Examples:

Calling the getRegexMatchSet operation

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

Parameters:

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:

      • RegexMatchSet — (map)

        Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For more information, see RegexMatchTuple.

        • RegexMatchSetId — (String)

          The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet (see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see DeleteRegexMatchSet).

          RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

        • Name — (String)

          A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

        • RegexMatchTuples — (Array<map>)

          Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:

          • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

          • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

          • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for the RegexPatternSet.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            CMD_LINE

            When you're concerned that attackers are injecting an operating system commandline 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 to perform any text transformations.

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

            The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

            RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

Returns:

  • (AWS.Request) —

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

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

Returns the RegexPatternSet specified by RegexPatternSetId.

Service Reference:

Examples:

Calling the getRegexPatternSet operation

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

Parameters:

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)

        Information about the RegexPatternSet that you specified in the GetRegexPatternSet request, including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.

        • RegexPatternSetId — required — (String)

          The identifier for the RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

          RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

        • Name — (String)

          A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

        • RegexPatternStrings — required — (Array<String>)

          Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as B[a@]dB[o0]t.

Returns:

  • (AWS.Request) —

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

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

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

Service Reference:

Examples:

To get a rule


/* The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  RuleId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Rule: {
     MetricName: "WAFByteHeaderRule", 
     Name: "WAFByteHeaderRule", 
     Predicates: [
        {
       DataId: "MyByteMatchSetID", 
       Negated: false, 
       Type: "ByteMatch"
      }
     ], 
     RuleId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
    }
   }
   */
 });

Calling the getRule operation

var params = {
  RuleId: 'STRING_VALUE' /* required */
};
waf.getRule(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: {}) —
    • RuleId — (String)

      The RuleId of the Rule that you want to get. RuleId is returned by CreateRule and by ListRules.

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:

      • Rule — (map)

        Information about the Rule that you specified in the GetRule request. For more information, see the following topics:

        • Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId

        • Predicate: Each Predicate object contains DataId, Negated, and Type

        • RuleId — required — (String)

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Name — (String)

          The friendly name or description for the Rule. You can't change the name of a Rule after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the Rule.

        • Predicates — required — (Array<map>)

          The Predicates object contains one Predicate element for each ByteMatchSet, IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.

          • Negated — required — (Boolean)

            Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

            Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

          • Type — required — (String)

            The type of predicate in a Rule, such as ByteMatch or IPSet.

            Possible values include:
            • "IPMatch"
            • "ByteMatch"
            • "SqlInjectionMatch"
            • "GeoMatch"
            • "SizeConstraint"
            • "XssMatch"
            • "RegexMatch"
          • DataId — required — (String)

            A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

Returns:

  • (AWS.Request) —

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

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

Returns the RuleGroup that is specified by the RuleGroupId that you included in the GetRuleGroup request.

To view the rules in a rule group, use ListActivatedRulesInRuleGroup.

Service Reference:

Examples:

Calling the getRuleGroup operation

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

Parameters:

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)

        Information about the RuleGroup that you specified in the GetRuleGroup request.

        • RuleGroupId — required — (String)

          A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

          RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

        • Name — (String)

          The friendly name or description for the RuleGroup. You can't change the name of a RuleGroup after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

Returns:

  • (AWS.Request) —

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

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

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:

To get a sampled requests


/* The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z. */

 var params = {
  MaxItems: 100, 
  RuleId: "WAFRule-1-Example", 
  TimeWindow: {
   EndTime: <Date Representation>, 
   StartTime: <Date Representation>
  }, 
  WebAclId: "createwebacl-1472061481310"
 };
 waf.getSampledRequests(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    PopulationSize: 50, 
    SampledRequests: [
       {
      Action: "BLOCK", 
      Request: {
       ClientIP: "192.0.2.44", 
       Country: "US", 
       HTTPVersion: "HTTP/1.1", 
       Headers: [
          {
         Name: "User-Agent", 
         Value: "BadBot "
        }
       ], 
       Method: "HEAD"
      }, 
      Timestamp: <Date Representation>, 
      Weight: 1
     }
    ], 
    TimeWindow: {
     EndTime: <Date Representation>, 
     StartTime: <Date Representation>
    }
   }
   */
 });

Calling the getSampledRequests operation

var params = {
  MaxItems: 'NUMBER_VALUE', /* required */
  RuleId: 'STRING_VALUE', /* 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 */
  },
  WebAclId: 'STRING_VALUE' /* required */
};
waf.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: {}) —
    • WebAclId — (String)

      The WebACLId of the WebACL for which you want GetSampledRequests to return a sample of requests.

    • RuleId — (String)

      RuleId is one of three values:

      • The RuleId of the Rule or the RuleGroupId of the RuleGroup for which you want GetSampledRequests to return a sample of requests.

      • Default_Action, which causes GetSampledRequests to return a sample of the requests that didn't match any of the rules in the specified WebACL.

    • 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. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

      • StartTime — required — (Date)

        The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

      • EndTime — required — (Date)

        The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "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.

        • Request — required — (map)

          A complex type that contains detailed information about the request.

          • ClientIP — (String)

            The IP address that the request originated from. If the WebACL 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 part of a web request that identifies the resource, for example, /images/daily-ad.jpg.

          • Method — (String)

            The HTTP method specified in the sampled web request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

          • HTTPVersion — (String)

            The HTTP version specified in the sampled web request, for example, HTTP/1.1.

          • Headers — (Array<map>)

            A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.

            • Name — (String)

              The name of one of the headers in the sampled web request.

            • Value — (String)

              The value of one of the headers in the sampled web request.

        • Weight — required — (Integer)

          A value that indicates how one result in the response relates proportionally to other results in the response. A result that has a weight of 2 represents roughly twice as many CloudFront 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.

        • RuleWithinRuleGroup — (String)

          This value is returned if the GetSampledRequests request specifies the ID of a RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule within the specified RuleGroup that matched the request listed in the response.

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

        • StartTime — required — (Date)

          The beginning of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "2016-09-27T14:50Z". You can specify any time range in the previous three hours.

        • EndTime — required — (Date)

          The end of the time range from which you want GetSampledRequests to return a sample of the requests that your AWS resource received. Specify the date and time in the following format: "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.

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

Returns the SizeConstraintSet specified by SizeConstraintSetId.

Service Reference:

Examples:

To get a size constraint set


/* The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getSizeConstraintSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SizeConstraintSet: {
     Name: "MySampleSizeConstraintSet", 
     SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     SizeConstraints: [
        {
       ComparisonOperator: "GT", 
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       Size: 0, 
       TextTransformation: "NONE"
      }
     ]
    }
   }
   */
 });

Calling the getSizeConstraintSet operation

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

Parameters:

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:

      • SizeConstraintSet — (map)

        Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet request. For more information, see the following topics:

        • SizeConstraintSetId — required — (String)

          A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get information about a SizeConstraintSet (see GetSizeConstraintSet), update a SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).

          SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

        • Name — (String)

          The name, if any, of the SizeConstraintSet.

        • SizeConstraints — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect the size of.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for the size constraint.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

            NONE

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

            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.

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

            The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

            EQ: Used to test if the Size is equal to the size of the FieldToMatch

            NE: Used to test if the Size is not equal to the size of the FieldToMatch

            LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

            LT: Used to test if the Size is strictly less than the size of the FieldToMatch

            GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

            GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

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

            The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

            Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

            If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

Returns:

  • (AWS.Request) —

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

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

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

Service Reference:

Examples:

To get a SQL injection match set


/* The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getSqlInjectionMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SqlInjectionMatchSet: {
     Name: "MySQLInjectionMatchSet", 
     SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     SqlInjectionMatchTuples: [
        {
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       TextTransformation: "URL_DECODE"
      }
     ]
    }
   }
   */
 });

Calling the getSqlInjectionMatchSet operation

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

Parameters:

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:

      • SqlInjectionMatchSet — (map)

        Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet request. For more information, see the following topics:

        • SqlInjectionMatchSetId — required — (String)

          A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a SqlInjectionMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see DeleteSqlInjectionMatchSet).

          SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

        • Name — (String)

          The name, if any, of the SqlInjectionMatchSet.

        • SqlInjectionMatchTuples — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for snippets of malicious SQL code.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

            Possible values include:
            • "NONE"
            • "COMPRESS_WHITE_SPACE"
            • "HTML_ENTITY_DECODE"
            • "LOWERCASE"
            • "CMD_LINE"
            • "URL_DECODE"

Returns:

  • (AWS.Request) —

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

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

Returns the WebACL that is specified by WebACLId.

Service Reference:

Examples:

To get a web ACL


/* The following example returns the details of a web ACL with the ID createwebacl-1472061481310. */

 var params = {
  WebACLId: "createwebacl-1472061481310"
 };
 waf.getWebACL(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    WebACL: {
     DefaultAction: {
      Type: "ALLOW"
     }, 
     MetricName: "CreateExample", 
     Name: "CreateExample", 
     Rules: [
        {
       Action: {
        Type: "ALLOW"
       }, 
       Priority: 1, 
       RuleId: "WAFRule-1-Example"
      }
     ], 
     WebACLId: "createwebacl-1472061481310"
    }
   }
   */
 });

Calling the getWebACL operation

var params = {
  WebACLId: 'STRING_VALUE' /* required */
};
waf.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: {}) —

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)

        Information about the WebACL that you specified in the GetWebACL request. For more information, see the following topics:

        • WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId

        • DefaultAction (Data type is WafAction): Contains Type

        • Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId

        • Action: Contains Type

        • WebACLId — required — (String)

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

        • Name — (String)

          A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

        • MetricName — (String)

          A friendly name or description for the metrics for this WebACL. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you create the WebACL.

        • DefaultAction — required — (map)

          The action to perform if none of the Rules contained in the WebACL match. The action is specified by the WafAction object.

          • Type — required — (String)

            Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

            • ALLOW: AWS WAF allows requests

            • BLOCK: AWS WAF blocks requests

            • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

            Possible values include:
            • "BLOCK"
            • "ALLOW"
            • "COUNT"
        • Rules — required — (Array<map>)

          An array that contains the action for each Rule in a WebACL, the priority of the Rule, and the ID of the Rule.

          • Priority — required — (Integer)

            Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

          • RuleId — required — (String)

            The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

            RuleId is returned by CreateRule and by ListRules.

          • Action — (map)

            Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

            • ALLOW: CloudFront responds with the requested object.

            • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

            • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

            ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

            • Type — required — (String)

              Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

              • ALLOW: AWS WAF allows requests

              • BLOCK: AWS WAF blocks requests

              • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

              Possible values include:
              • "BLOCK"
              • "ALLOW"
              • "COUNT"
          • OverrideAction — (map)

            Use the OverrideAction to test your RuleGroup.

            Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

            ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

            • Type — required — (String)

              COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

              Possible values include:
              • "NONE"
              • "COUNT"
          • Type — (String)

            The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

            Possible values include:
            • "REGULAR"
            • "RATE_BASED"
            • "GROUP"
          • ExcludedRules — (Array<map>)

            An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

            Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

            Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

            If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

            1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

            2. Submit an UpdateWebACL request that has two actions:

              • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

              • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

            • RuleId — required — (String)

              The unique identifier for the rule to exclude from the rule group.

        • WebACLArn — (String)

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

Returns:

  • (AWS.Request) —

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

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

Returns the XssMatchSet that is specified by XssMatchSetId.

Service Reference:

Examples:

To get an XSS match set


/* The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.getXssMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    XssMatchSet: {
     Name: "MySampleXssMatchSet", 
     XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
     XssMatchTuples: [
        {
       FieldToMatch: {
        Type: "QUERY_STRING"
       }, 
       TextTransformation: "URL_DECODE"
      }
     ]
    }
   }
   */
 });

Calling the getXssMatchSet operation

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

Parameters:

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:

      • XssMatchSet — (map)

        Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more information, see the following topics:

        • XssMatchSet: Contains Name, XssMatchSetId, and an array of XssMatchTuple objects

        • XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and TextTransformation

        • FieldToMatch: Contains Data and Type

        • XssMatchSetId — required — (String)

          A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

          XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

        • Name — (String)

          The name, if any, of the XssMatchSet.

        • XssMatchTuples — required — (Array<map>)

          Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.

          • FieldToMatch — required — (map)

            Specifies where in a web request to look for cross-site scripting attacks.

            • Type — required — (String)

              The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

              • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

              • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

              • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

              • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

              • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

              • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

              • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

              Possible values include:
              • "URI"
              • "QUERY_STRING"
              • "HEADER"
              • "METHOD"
              • "BODY"
              • "SINGLE_QUERY_ARG"
              • "ALL_QUERY_ARGS"
            • Data — (String)

              When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

              When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

              If the value of Type is any other value, omit Data.

          • TextTransformation — required — (String)

            Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

            You can only specify a single type of TextTransformation.

            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 to perform any text transformations.

            Possible values include:
            • "NONE"
            • "COMPRESS_WHITE_SPACE"
            • "HTML_ENTITY_DECODE"
            • "LOWERCASE"
            • "CMD_LINE"
            • "URL_DECODE"

Returns:

  • (AWS.Request) —

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

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

Returns an array of ActivatedRule objects.

Service Reference:

Examples:

Calling the listActivatedRulesInRuleGroup operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE',
  RuleGroupId: 'STRING_VALUE'
};
waf.listActivatedRulesInRuleGroup(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: {}) —
    • RuleGroupId — (String)

      The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule objects.

    • NextMarker — (String)

      If you specify a value for Limit and you have more ActivatedRules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ActivatedRules. For the second and subsequent ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the previous response to get information about another batch of ActivatedRules.

    • Limit — (Integer)

      Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have more ActivatedRules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ActivatedRules.

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)

        If you have more ActivatedRules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ActivatedRules, submit another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • ActivatedRules — (Array<map>)

        An array of ActivatedRules objects.

        • Priority — required — (Integer)

          Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

        • RuleId — required — (String)

          The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Action — (map)

          Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

          • ALLOW: CloudFront responds with the requested object.

          • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

          • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

            • ALLOW: AWS WAF allows requests

            • BLOCK: AWS WAF blocks requests

            • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

            Possible values include:
            • "BLOCK"
            • "ALLOW"
            • "COUNT"
        • OverrideAction — (map)

          Use the OverrideAction to test your RuleGroup.

          Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

            Possible values include:
            • "NONE"
            • "COUNT"
        • Type — (String)

          The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

          Possible values include:
          • "REGULAR"
          • "RATE_BASED"
          • "GROUP"
        • ExcludedRules — (Array<map>)

          An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

          Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

          Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

          If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

          1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

          2. Submit an UpdateWebACL request that has two actions:

            • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

            • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

          • RuleId — required — (String)

            The unique identifier for the rule to exclude from the rule group.

Returns:

  • (AWS.Request) —

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

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

Returns an array of ByteMatchSetSummary objects.

Service Reference:

Examples:

Calling the listByteMatchSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listByteMatchSets(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)

      If you specify a value for Limit and you have more ByteMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListByteMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of ByteMatchSets.

    • Limit — (Integer)

      Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If you have more ByteMatchSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of ByteMatchSet 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)

        If you have more ByteMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more ByteMatchSet objects, submit another ListByteMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • ByteMatchSets — (Array<map>)

        An array of ByteMatchSetSummary objects.

        • ByteMatchSetId — required — (String)

          The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get information about a ByteMatchSet, update a ByteMatchSet, remove a ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.

          ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

        • Name — required — (String)

          A friendly name or description of the ByteMatchSet. You can't change Name after you create a ByteMatchSet.

Returns:

  • (AWS.Request) —

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

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

Returns an array of GeoMatchSetSummary objects in the response.

Service Reference:

Examples:

Calling the listGeoMatchSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listGeoMatchSets(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)

      If you specify a value for Limit and you have more GeoMatchSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of GeoMatchSet objects.

    • Limit — (Integer)

      Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you have more GeoMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of GeoMatchSet 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)

        If you have more GeoMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more GeoMatchSet objects, submit another ListGeoMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • GeoMatchSets — (Array<map>)

        An array of GeoMatchSetSummary objects.

        • GeoMatchSetId — required — (String)

          The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a GetGeoMatchSet request to get detailed information about an GeoMatchSet.

        • Name — required — (String)

          A friendly name or description of the GeoMatchSet. You can't change the name of an GeoMatchSet after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of IPSetSummary objects in the response.

Service Reference:

Examples:

To list IP sets


/* The following example returns an array of up to 100 IP match sets. */

 var params = {
  Limit: 100
 };
 waf.listIPSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    IPSets: [
       {
      IPSetId: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
      Name: "MyIPSetFriendlyName"
     }
    ]
   }
   */
 });

Calling the listIPSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.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: {}) —
    • NextMarker — (String)

      If you specify a value for Limit and you have more IPSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of IPSets. For the second and subsequent ListIPSets requests, specify the value of NextMarker from the previous response to get information about another batch of IPSets.

    • Limit — (Integer)

      Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have more IPSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of IPSet 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)

        If you have more IPSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more IPSet objects, submit another ListIPSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • IPSets — (Array<map>)

        An array of IPSetSummary objects.

        • IPSetId — required — (String)

          The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

        • Name — required — (String)

          A friendly name or description of the IPSet. You can't change the name of an IPSet after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of LoggingConfiguration objects.

Service Reference:

Examples:

Calling the listLoggingConfigurations operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.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: {}) —
    • NextMarker — (String)

      If you specify a value for Limit and you have more LoggingConfigurations than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of LoggingConfigurations. For the second and subsequent ListLoggingConfigurations requests, specify the value of NextMarker from the previous response to get information about another batch of ListLoggingConfigurations.

    • Limit — (Integer)

      Specifies the number of LoggingConfigurations that you want AWS WAF to return for this request. If you have more LoggingConfigurations than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of LoggingConfigurations.

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>)

        An array of LoggingConfiguration objects.

        • ResourceArn — required — (String)

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

        • LogDestinationConfigs — required — (Array<String>)

          An array of Amazon Kinesis Data Firehose ARNs.

        • RedactedFields — (Array<map>)

          The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

      • NextMarker — (String)

        If you have more LoggingConfigurations than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more LoggingConfigurations, submit another ListLoggingConfigurations request, and specify the NextMarker value from the response in the NextMarker value in the next request.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RuleSummary objects.

Service Reference:

Examples:

Calling the listRateBasedRules operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listRateBasedRules(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)

      If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRateBasedRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    • Limit — (Integer)

      Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

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)

        If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRateBasedRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • Rules — (Array<map>)

        An array of RuleSummary objects.

        • RuleId — required — (String)

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Name — required — (String)

          A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RegexMatchSetSummary objects.

Service Reference:

Examples:

Calling the listRegexMatchSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listRegexMatchSets(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)

      If you specify a value for Limit and you have more RegexMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexMatchSet objects.

    • Limit — (Integer)

      Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If you have more RegexMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexMatchSet 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)

        If you have more RegexMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexMatchSet objects, submit another ListRegexMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • RegexMatchSets — (Array<map>)

        An array of RegexMatchSetSummary objects.

        • RegexMatchSetId — required — (String)

          The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get information about a RegexMatchSet, update a RegexMatchSet, remove a RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF.

          RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

        • Name — required — (String)

          A friendly name or description of the RegexMatchSet. You can't change Name after you create a RegexMatchSet.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RegexPatternSetSummary objects.

Service Reference:

Examples:

Calling the listRegexPatternSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.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: {}) —
    • NextMarker — (String)

      If you specify a value for Limit and you have more RegexPatternSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RegexPatternSet objects. For the second and subsequent ListRegexPatternSets requests, specify the value of NextMarker from the previous response to get information about another batch of RegexPatternSet objects.

    • Limit — (Integer)

      Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If you have more RegexPatternSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RegexPatternSet 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)

        If you have more RegexPatternSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RegexPatternSet objects, submit another ListRegexPatternSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • RegexPatternSets — (Array<map>)

        An array of RegexPatternSetSummary objects.

        • RegexPatternSetId — required — (String)

          The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet, update a RegexPatternSet, remove a RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from AWS WAF.

          RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

        • Name — required — (String)

          A friendly name or description of the RegexPatternSet. You can't change Name after you create a RegexPatternSet.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RuleGroup objects.

Service Reference:

Examples:

Calling the listRuleGroups operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.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: {}) —
    • NextMarker — (String)

      If you specify a value for Limit and you have more RuleGroups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of RuleGroups. For the second and subsequent ListRuleGroups requests, specify the value of NextMarker from the previous response to get information about another batch of RuleGroups.

    • Limit — (Integer)

      Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have more RuleGroups than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of RuleGroups.

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)

        If you have more RuleGroups than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more RuleGroups, submit another ListRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • RuleGroups — (Array<map>)

        An array of RuleGroup objects.

        • RuleGroupId — required — (String)

          A unique identifier for a RuleGroup. You use RuleGroupId to get more information about a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup), insert a RuleGroup into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).

          RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

        • Name — required — (String)

          A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RuleSummary objects.

Service Reference:

Examples:

To list rules


/* The following example returns an array of up to 100 rules. */

 var params = {
  Limit: 100
 };
 waf.listRules(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    Rules: [
       {
      Name: "WAFByteHeaderRule", 
      RuleId: "WAFRule-1-Example"
     }
    ]
   }
   */
 });

Calling the listRules operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listRules(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)

      If you specify a value for Limit and you have more Rules than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of Rules. For the second and subsequent ListRules requests, specify the value of NextMarker from the previous response to get information about another batch of Rules.

    • Limit — (Integer)

      Specifies the number of Rules that you want AWS WAF to return for this request. If you have more Rules than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

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)

        If you have more Rules than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more Rules, submit another ListRules request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • Rules — (Array<map>)

        An array of RuleSummary objects.

        • RuleId — required — (String)

          A unique identifier for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Name — required — (String)

          A friendly name or description of the Rule. You can't change the name of a Rule after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of SizeConstraintSetSummary objects.

Service Reference:

Examples:

To list a size constraint sets


/* The following example returns an array of up to 100 size contraint match sets. */

 var params = {
  Limit: 100
 };
 waf.listSizeConstraintSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SizeConstraintSets: [
       {
      Name: "MySampleSizeConstraintSet", 
      SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
     }
    ]
   }
   */
 });

Calling the listSizeConstraintSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listSizeConstraintSets(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)

      If you specify a value for Limit and you have more SizeConstraintSets than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SizeConstraintSets. For the second and subsequent ListSizeConstraintSets requests, specify the value of NextMarker from the previous response to get information about another batch of SizeConstraintSets.

    • Limit — (Integer)

      Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request. If you have more SizeConstraintSets objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of SizeConstraintSet 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)

        If you have more SizeConstraintSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • SizeConstraintSets — (Array<map>)

        An array of SizeConstraintSetSummary objects.

Returns:

  • (AWS.Request) —

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

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

Returns an array of SqlInjectionMatchSet objects.

Service Reference:

Examples:

To list SQL injection match sets


/* The following example returns an array of up to 100 SQL injection match sets. */

 var params = {
  Limit: 100
 };
 waf.listSqlInjectionMatchSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    SqlInjectionMatchSets: [
       {
      Name: "MySQLInjectionMatchSet", 
      SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
     }
    ]
   }
   */
 });

Calling the listSqlInjectionMatchSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listSqlInjectionMatchSets(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)

      If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of SqlInjectionMatchSets. For the second and subsequent ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of SqlInjectionMatchSets.

    • Limit — (Integer)

      Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If you have more SqlInjectionMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

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)

        If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • SqlInjectionMatchSets — (Array<map>)

        An array of SqlInjectionMatchSetSummary objects.

Returns:

  • (AWS.Request) —

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

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

Returns an array of RuleGroup objects that you are subscribed to.

Service Reference:

Examples:

Calling the listSubscribedRuleGroups operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listSubscribedRuleGroups(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)

      If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of subscribed rule groups. For the second and subsequent ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the previous response to get information about another batch of subscribed rule groups.

    • Limit — (Integer)

      Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another 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)

        If you have more objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more objects, submit another ListSubscribedRuleGroups request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • RuleGroups — (Array<map>)

        An array of RuleGroup objects.

        • RuleGroupId — required — (String)

          A unique identifier for a RuleGroup.

        • Name — required — (String)

          A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup after you create it.

        • MetricName — required — (String)

          A friendly name or description for the metrics for this RuleGroup. The name can contain only alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you create the RuleGroup.

Returns:

  • (AWS.Request) —

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

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

Returns an array of WebACLSummary objects in the response.

Service Reference:

Examples:

To list Web ACLs


/* The following example returns an array of up to 100 web ACLs. */

 var params = {
  Limit: 100
 };
 waf.listWebACLs(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    WebACLs: [
       {
      Name: "WebACLexample", 
      WebACLId: "webacl-1472061481310"
     }
    ]
   }
   */
 });

Calling the listWebACLs operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.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: {}) —
    • NextMarker — (String)

      If you specify a value for Limit and you have more WebACL objects than the number that you specify for Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of WebACL objects. For the second and subsequent ListWebACLs requests, specify the value of NextMarker from the previous response to get information about another batch of WebACL objects.

    • Limit — (Integer)

      Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have more WebACL objects than the number that you specify for Limit, the response includes a NextMarker value that you can use to get another batch of WebACL 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)

        If you have more WebACL objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more WebACL objects, submit another ListWebACLs request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • WebACLs — (Array<map>)

        An array of WebACLSummary objects.

        • WebACLId — required — (String)

          A unique identifier for a WebACL. You use WebACLId to get information about a WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a WebACL from AWS WAF (see DeleteWebACL).

          WebACLId is returned by CreateWebACL and by ListWebACLs.

        • Name — required — (String)

          A friendly name or description of the WebACL. You can't change the name of a WebACL after you create it.

Returns:

  • (AWS.Request) —

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

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

Returns an array of XssMatchSet objects.

Service Reference:

Examples:

To list XSS match sets


/* The following example returns an array of up to 100 XSS match sets. */

 var params = {
  Limit: 100
 };
 waf.listXssMatchSets(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    XssMatchSets: [
       {
      Name: "MySampleXssMatchSet", 
      XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
     }
    ]
   }
   */
 });

Calling the listXssMatchSets operation

var params = {
  Limit: 'NUMBER_VALUE',
  NextMarker: 'STRING_VALUE'
};
waf.listXssMatchSets(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)

      If you specify a value for Limit and you have more XssMatchSet objects than the value of Limit, AWS WAF returns a NextMarker value in the response that allows you to list another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests, specify the value of NextMarker from the previous response to get information about another batch of XssMatchSets.

    • Limit — (Integer)

      Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have more XssMatchSet objects than the number you specify for Limit, the response includes a NextMarker value that you can use to get another batch of Rules.

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)

        If you have more XssMatchSet objects than the number that you specified for Limit in the request, the response includes a NextMarker value. To list more XssMatchSet objects, submit another ListXssMatchSets request, and specify the NextMarker value from the response in the NextMarker value in the next request.

      • XssMatchSets — (Array<map>)

        An array of XssMatchSetSummary objects.

        • XssMatchSetId — required — (String)

          A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see DeleteXssMatchSet).

          XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

        • Name — required — (String)

          The name of the XssMatchSet, if any, specified by Id.

Returns:

  • (AWS.Request) —

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

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

Associates a LoggingConfiguration with a specified web ACL.

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. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

  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 */
    RedactedFields: [
      {
        Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
        Data: 'STRING_VALUE'
      },
      /* more items */
    ]
  }
};
waf.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)

      The Amazon Kinesis Data Firehose that contains the inspected traffic information, the redacted fields details, and the Amazon Resource Name (ARN) of the web ACL to monitor.

      • ResourceArn — required — (String)

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

      • LogDestinationConfigs — required — (Array<String>)

        An array of Amazon Kinesis Data Firehose ARNs.

      • RedactedFields — (Array<map>)

        The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

        • Type — required — (String)

          The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

          • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

          • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

          • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

          • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

          • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

          • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

          • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

          Possible values include:
          • "URI"
          • "QUERY_STRING"
          • "HEADER"
          • "METHOD"
          • "BODY"
          • "SINGLE_QUERY_ARG"
          • "ALL_QUERY_ARGS"
        • Data — (String)

          When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

          When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

          If the value of Type is any other value, omit Data.

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 that you submitted in the request.

        • ResourceArn — required — (String)

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

        • LogDestinationConfigs — required — (Array<String>)

          An array of Amazon Kinesis Data Firehose ARNs.

        • RedactedFields — (Array<map>)

          The parts of the request that you want redacted from the logs. For example, if you redact the cookie field, the cookie field in the firehose will be xxx.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

Returns:

  • (AWS.Request) —

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

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

Attaches a IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.

The PutPermissionPolicy is subject to the following restrictions:

  • You can attach only one policy with each PutPermissionPolicy request.

  • The policy must include an Effect, Action and Principal.

  • Effect must specify Allow.

  • The Action in the policy must be waf:UpdateWebACL, waf-regional:UpdateWebACL, waf:GetRuleGroup and waf-regional:GetRuleGroup . Any extra or wildcard actions in the policy will be rejected.

  • The policy cannot include a Resource parameter.

  • The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.

  • The user making the request must be the owner of the RuleGroup.

  • Your policy must be composed using IAM Policy version 2012-10-17.

For more information, see IAM Policies.

An example of a valid policy parameter is shown in the Examples section below.

Service Reference:

Examples:

Calling the putPermissionPolicy operation

var params = {
  Policy: 'STRING_VALUE', /* required */
  ResourceArn: 'STRING_VALUE' /* required */
};
waf.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 RuleGroup.

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.

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

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

  • The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

  • Where to look, such as at the beginning or the end of a query string.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

To create and configure a ByteMatchSet, perform the following steps:

  1. Create a ByteMatchSet. For more information, see CreateByteMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

  3. Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update a byte match set


/* The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ByteMatchSetId: "exampleIDs3t-46da-4fdb-b8d5-abc321j569j5", 
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Updates: [
     {
    Action: "DELETE", 
    ByteMatchTuple: {
     FieldToMatch: {
      Data: "referer", 
      Type: "HEADER"
     }, 
     PositionalConstraint: "CONTAINS", 
     TargetString: <Binary String>, 
     TextTransformation: "NONE"
    }
   }
  ]
 };
 waf.updateByteMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateByteMatchSet operation

var params = {
  ByteMatchSetId: 'STRING_VALUE', /* required */
  ChangeToken: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      ByteMatchTuple: { /* required */
        FieldToMatch: { /* required */
          Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
          Data: 'STRING_VALUE'
        },
        PositionalConstraint: EXACTLY | STARTS_WITH | ENDS_WITH | CONTAINS | CONTAINS_WORD, /* required */
        TargetString: new Buffer('...') || 'STRING_VALUE' /* Strings will be Base-64 encoded on your behalf */, /* required */
        TextTransformation: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
      }
    },
    /* more items */
  ]
};
waf.updateByteMatchSet(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: {}) —
    • ByteMatchSetId — (String)

      The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of ByteMatchSetUpdate objects that you want to insert into or delete from a ByteMatchSet. For more information, see the applicable data types:

      • Action — required — (String)

        Specifies whether to insert or delete a ByteMatchTuple.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • ByteMatchTuple — required — (map)

        Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF to search for. If you specify DELETE for the value of Action, the ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want to delete from the ByteMatchSet.

        • FieldToMatch — required — (map)

          The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TargetString — required — (Buffer, Typed Array, Blob, String)

          The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.

          Valid values depend on the values that you specified for FieldToMatch:

          • HEADER: The value that you want AWS WAF to search for in the request header that you specified in FieldToMatch, for example, the value of the User-Agent or Referer header.

          • METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

          • QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part of a URL that appears after a ? character.

          • URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource, for example, /images/daily-ad.jpg.

          • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

          • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

          • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but instead of inspecting a single parameter, AWS WAF inspects all parameters within the query string for the value or regex pattern that you specify in TargetString.

          If TargetString 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 TargetString.

          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.

        • TextTransformation — required — (String)

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          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 to perform any text transformations.

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

          Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:

          CONTAINS

          The specified part of the web request must include the value of TargetString, but the location doesn't matter.

          CONTAINS_WORD

          The specified part of the web request must include the value of TargetString, and TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or ). In addition, TargetString must be a word, which means one of the following:

          • TargetString exactly matches the value of the specified part of the web request, such as the value of a header.

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

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

          • TargetString is in the middle of the specified part of the web request and is preceded and followed by characters other than alphanumeric characters or underscore (), for example, -BadBot;.

          EXACTLY

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

          STARTS_WITH

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

          ENDS_WITH

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

          Possible values include:
          • "EXACTLY"
          • "STARTS_WITH"
          • "ENDS_WITH"
          • "CONTAINS"
          • "CONTAINS_WORD"

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes GeoMatchConstraint objects in an GeoMatchSet. For each GeoMatchConstraint object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an GeoMatchConstraint object, you delete the existing object and add a new one.

  • The Type. The only valid value for Type is Country.

  • The Value, which is a two character code for the country to add to the GeoMatchConstraint object. Valid codes are listed in GeoMatchConstraint$Value.

To create and configure an GeoMatchSet, perform the following steps:

  1. Submit a CreateGeoMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

  3. Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the updateGeoMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  GeoMatchSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      GeoMatchConstraint: { /* required */
        Type: Country, /* required */
        Value: 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 /* required */
      }
    },
    /* more items */
  ]
};
waf.updateGeoMatchSet(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: {}) —
    • GeoMatchSetId — (String)

      The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of GeoMatchSetUpdate objects that you want to insert into or delete from an GeoMatchSet. For more information, see the applicable data types:

      • GeoMatchSetUpdate: Contains Action and GeoMatchConstraint

      • GeoMatchConstraint: Contains Type and Value

        You can have only one Type and Value per GeoMatchConstraint. To add multiple countries, include multiple GeoMatchSetUpdate objects in your request.

      • Action — required — (String)

        Specifies whether to insert or delete a country with UpdateGeoMatchSet.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • GeoMatchConstraint — required — (map)

        The country from which web requests originate that you want AWS WAF to search for.

        • Type — required — (String)

          The type of geographical area you want AWS WAF to search for. Currently Country is the only valid value.

          Possible values include:
          • "Country"
        • Value — required — (String)

          The country that you want AWS WAF to search for.

          Possible values include:
          • "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"

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change an IPSetDescriptor object, you delete the existing object and add a new one.

  • The IP address version, IPv4 or IPv6.

  • The IP address in CIDR notation, for example, 192.0.2.0/24 (for the range of IP addresses from 192.0.2.0 to 192.0.2.255) or 192.0.2.44/32 (for the individual IP address 192.0.2.44).

AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

IPv6 addresses can be represented using any of the following formats:

  • 1111:0000:0000:0000:0000:0000:0000:0111/128

  • 1111:0:0:0:0:0:0:0111/128

  • 1111::0111/128

  • 1111::111/128

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

  1. Submit a CreateIPSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

You can insert a maximum of 1000 addresses in a single request.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update an IP set


/* The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  IPSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
  Updates: [
     {
    Action: "DELETE", 
    IPSetDescriptor: {
     Type: "IPV4", 
     Value: "192.0.2.44/32"
    }
   }
  ]
 };
 waf.updateIPSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateIPSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  IPSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      IPSetDescriptor: { /* required */
        Type: IPV4 | IPV6, /* required */
        Value: 'STRING_VALUE' /* required */
      }
    },
    /* more items */
  ]
};
waf.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: {}) —
    • IPSetId — (String)

      The IPSetId of the IPSet that you want to update. IPSetId is returned by CreateIPSet and by ListIPSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For more information, see the applicable data types:

      You can insert a maximum of 1000 addresses in a single request.

      • Action — required — (String)

        Specifies whether to insert or delete an IP address with UpdateIPSet.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • IPSetDescriptor — required — (map)

        The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web requests originate from.

        • Type — required — (String)

          Specify IPV4 or IPV6.

          Possible values include:
          • "IPV4"
          • "IPV6"
        • Value — required — (String)

          Specify an IPv4 address by using CIDR notation. For example:

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

          For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.

          Specify an IPv6 address by using CIDR notation. For example:

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

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateIPSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

  • An IPSet that matches the IP address 192.0.2.44/32

  • A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 15,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 15,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

  • A ByteMatchSet with FieldToMatch of URI

  • A PositionalConstraint of STARTS_WITH

  • A TargetString of login

Further, you specify a RateLimit of 15,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

Service Reference:

Examples:

Calling the updateRateBasedRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RateLimit: 'NUMBER_VALUE', /* required */
  RuleId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      Predicate: { /* required */
        DataId: 'STRING_VALUE', /* required */
        Negated: true || false, /* required */
        Type: IPMatch | ByteMatch | SqlInjectionMatch | GeoMatch | SizeConstraint | XssMatch | RegexMatch /* required */
      }
    },
    /* more items */
  ]
};
waf.updateRateBasedRule(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: {}) —
    • RuleId — (String)

      The RuleId of the RateBasedRule that you want to update. RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.

      • Action — required — (String)

        Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • Predicate — required — (map)

        The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

        • Negated — required — (Boolean)

          Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

          Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

        • Type — required — (String)

          The type of predicate in a Rule, such as ByteMatch or IPSet.

          Possible values include:
          • "IPMatch"
          • "ByteMatch"
          • "SqlInjectionMatch"
          • "GeoMatch"
          • "SizeConstraint"
          • "XssMatch"
          • "RegexMatch"
        • DataId — required — (String)

          A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

    • RateLimit — (Integer)

      The maximum number of requests, which have an identical value in the field specified by the RateKey, allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each RegexMatchSetUpdate object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a RegexMatchSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the User-Agent header.

  • The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.

  • Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can create a RegexPatternSet that matches any requests with User-Agent headers that contain the string B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexMatchSet, perform the following steps:

  1. Create a RegexMatchSet. For more information, see CreateRegexMatchSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

  3. Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the updateRegexMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RegexMatchSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      RegexMatchTuple: { /* required */
        FieldToMatch: { /* required */
          Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
          Data: 'STRING_VALUE'
        },
        RegexPatternSetId: 'STRING_VALUE', /* required */
        TextTransformation: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
      }
    },
    /* more items */
  ]
};
waf.updateRegexMatchSet(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: {}) —
    • RegexMatchSetId — (String)

      The RegexMatchSetId of the RegexMatchSet that you want to update. RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.

    • Updates — (Array<map>)

      An array of RegexMatchSetUpdate objects that you want to insert into or delete from a RegexMatchSet. For more information, see RegexMatchTuple.

      • Action — required — (String)

        Specifies whether to insert or delete a RegexMatchTuple.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • RegexMatchTuple — required — (map)

        Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value of Action, the RegexMatchTuple values must exactly match the values in the RegexMatchTuple that you want to delete from the RegexMatchSet.

        • FieldToMatch — required — (map)

          Specifies where in a web request to look for the RegexPatternSet.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TextTransformation — required — (String)

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on RegexPatternSet before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          CMD_LINE

          When you're concerned that attackers are injecting an operating system commandline 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 to perform any text transformations.

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

          The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to get information about a RegexPatternSet (see GetRegexPatternSet), update a RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).

          RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes RegexPatternString objects in a RegexPatternSet. For each RegexPatternString object, you specify the following values:

  • Whether to insert or delete the RegexPatternString.

  • The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.

For example, you can create a RegexPatternString such as B[a@]dB[o0]t. AWS WAF will match this RegexPatternString to:

  • BadBot

  • BadB0t

  • B@dBot

  • B@dB0t

To create and configure a RegexPatternSet, perform the following steps:

  1. Create a RegexPatternSet. For more information, see CreateRegexPatternSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

  3. Submit an UpdateRegexPatternSet request to specify the regular expression pattern that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the updateRegexPatternSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RegexPatternSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      RegexPatternString: 'STRING_VALUE' /* required */
    },
    /* more items */
  ]
};
waf.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: {}) —
    • RegexPatternSetId — (String)

      The RegexPatternSetId of the RegexPatternSet that you want to update. RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.

    • Updates — (Array<map>)

      An array of RegexPatternSetUpdate objects that you want to insert into or delete from a RegexPatternSet.

      • Action — required — (String)

        Specifies whether to insert or delete a RegexPatternString.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • RegexPatternString — required — (String)

        Specifies the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

  • A ByteMatchSet that matches the value BadBot in the User-Agent header

  • An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBot and the request must originate from the IP address 192.0.2.44.

To create and configure a Rule, perform the following steps:

  1. Create and update the predicates that you want to include in the Rule.

  2. Create the Rule. See CreateRule.

  3. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

  4. Submit an UpdateRule request to add predicates to the Rule.

  5. Create and update a WebACL that contains the Rule. See CreateWebACL.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update a rule


/* The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  RuleId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
  Updates: [
     {
    Action: "DELETE", 
    Predicate: {
     DataId: "MyByteMatchSetID", 
     Negated: false, 
     Type: "ByteMatch"
    }
   }
  ]
 };
 waf.updateRule(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateRule operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RuleId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      Predicate: { /* required */
        DataId: 'STRING_VALUE', /* required */
        Negated: true || false, /* required */
        Type: IPMatch | ByteMatch | SqlInjectionMatch | GeoMatch | SizeConstraint | XssMatch | RegexMatch /* required */
      }
    },
    /* more items */
  ]
};
waf.updateRule(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: {}) —
    • RuleId — (String)

      The RuleId of the Rule that you want to update. RuleId is returned by CreateRule and by ListRules.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more information, see the applicable data types:

      • Action — required — (String)

        Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • Predicate — required — (map)

        The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

        • Negated — required — (Boolean)

          Set Negated to False if you want AWS WAF to allow, block, or count requests based on the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.

          Set Negated to True if you want AWS WAF to allow or block a request based on the negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

        • Type — required — (String)

          The type of predicate in a Rule, such as ByteMatch or IPSet.

          Possible values include:
          • "IPMatch"
          • "ByteMatch"
          • "SqlInjectionMatch"
          • "GeoMatch"
          • "SizeConstraint"
          • "XssMatch"
          • "RegexMatch"
        • DataId — required — (String)

          A unique identifier for a predicate in a Rule, such as ByteMatchSetId or IPSetId. The ID is returned by the corresponding Create or List command.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateRule request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes ActivatedRule objects in a RuleGroup.

You can only insert REGULAR rules into a rule group.

You can have a maximum of ten rules per rule group.

To create and configure a RuleGroup, perform the following steps:

  1. Create and update the Rules that you want to include in the RuleGroup. See CreateRule.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRuleGroup request.

  3. Submit an UpdateRuleGroup request to add Rules to the RuleGroup.

  4. Create and update a WebACL that contains the RuleGroup. See CreateWebACL.

If you want to replace one Rule with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

Calling the updateRuleGroup operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  RuleGroupId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      ActivatedRule: { /* required */
        Priority: 'NUMBER_VALUE', /* required */
        RuleId: 'STRING_VALUE', /* required */
        Action: {
          Type: BLOCK | ALLOW | COUNT /* required */
        },
        ExcludedRules: [
          {
            RuleId: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        OverrideAction: {
          Type: NONE | COUNT /* required */
        },
        Type: REGULAR | RATE_BASED | GROUP
      }
    },
    /* more items */
  ]
};
waf.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: {}) —
    • RuleGroupId — (String)

      The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.

    • Updates — (Array<map>)

      An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.

      You can only insert REGULAR rules into a rule group.

      ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

      • Action — required — (String)

        Specify INSERT to add an ActivatedRule to a RuleGroup. Use DELETE to remove an ActivatedRule from a RuleGroup.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • ActivatedRule — required — (map)

        The ActivatedRule object specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

        • Priority — required — (Integer)

          Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

        • RuleId — required — (String)

          The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Action — (map)

          Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

          • ALLOW: CloudFront responds with the requested object.

          • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

          • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

            • ALLOW: AWS WAF allows requests

            • BLOCK: AWS WAF blocks requests

            • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

            Possible values include:
            • "BLOCK"
            • "ALLOW"
            • "COUNT"
        • OverrideAction — (map)

          Use the OverrideAction to test your RuleGroup.

          Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

            Possible values include:
            • "NONE"
            • "COUNT"
        • Type — (String)

          The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

          Possible values include:
          • "REGULAR"
          • "RATE_BASED"
          • "GROUP"
        • ExcludedRules — (Array<map>)

          An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

          Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

          Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

          If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

          1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

          2. Submit an UpdateWebACL request that has two actions:

            • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

            • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

          • RuleId — required — (String)

            The unique identifier for the rule to exclude from the rule group.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values:

  • Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

  • The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

  • Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

    You can only specify a single type of TextTransformation.

  • A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

  • The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

To create and configure a SizeConstraintSet, perform the following steps:

  1. Create a SizeConstraintSet. For more information, see CreateSizeConstraintSet.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

  3. Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update a size constraint set


/* The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  SizeConstraintSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
  Updates: [
     {
    Action: "DELETE", 
    SizeConstraint: {
     ComparisonOperator: "GT", 
     FieldToMatch: {
      Type: "QUERY_STRING"
     }, 
     Size: 0, 
     TextTransformation: "NONE"
    }
   }
  ]
 };
 waf.updateSizeConstraintSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateSizeConstraintSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  SizeConstraintSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      SizeConstraint: { /* required */
        ComparisonOperator: EQ | NE | LE | LT | GE | GT, /* required */
        FieldToMatch: { /* required */
          Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
          Data: 'STRING_VALUE'
        },
        Size: 'NUMBER_VALUE', /* required */
        TextTransformation: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
      }
    },
    /* more items */
  ]
};
waf.updateSizeConstraintSet(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: {}) —
    • SizeConstraintSetId — (String)

      The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a SizeConstraintSet. For more information, see the applicable data types:

      • Action — required — (String)

        Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • SizeConstraint — required — (map)

        Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size, ComparisonOperator, and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

        • FieldToMatch — required — (map)

          Specifies where in a web request to look for the size constraint.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TextTransformation — required — (String)

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          Note that if you choose BODY for the value of Type, you must choose NONE for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.

          NONE

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

          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.

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

          The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided Size and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

          EQ: Used to test if the Size is equal to the size of the FieldToMatch

          NE: Used to test if the Size is not equal to the size of the FieldToMatch

          LE: Used to test if the Size is less than or equal to the size of the FieldToMatch

          LT: Used to test if the Size is strictly less than the size of the FieldToMatch

          GE: Used to test if the Size is greater than or equal to the size of the FieldToMatch

          GT: Used to test if the Size is strictly greater than the size of the FieldToMatch

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

          The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch. AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an expression in the form of "Size ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the SizeConstraint is considered to match.

          Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).

          If you specify URI for the value of Type, the / in the URI counts as one character. For example, the URI /logo.jpg is nine characters long.

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

    You can only specify a single type of TextTransformation.

You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure a SqlInjectionMatchSet, perform the following steps:

  1. Submit a CreateSqlInjectionMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update a SQL injection match set


/* The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  SqlInjectionMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5", 
  Updates: [
     {
    Action: "DELETE", 
    SqlInjectionMatchTuple: {
     FieldToMatch: {
      Type: "QUERY_STRING"
     }, 
     TextTransformation: "URL_DECODE"
    }
   }
  ]
 };
 waf.updateSqlInjectionMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateSqlInjectionMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  SqlInjectionMatchSetId: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      SqlInjectionMatchTuple: { /* required */
        FieldToMatch: { /* required */
          Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
          Data: 'STRING_VALUE'
        },
        TextTransformation: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
      }
    },
    /* more items */
  ]
};
waf.updateSqlInjectionMatchSet(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: {}) —
    • SqlInjectionMatchSetId — (String)

      The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a SqlInjectionMatchSet. For more information, see the applicable data types:

      • Action — required — (String)

        Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • SqlInjectionMatchTuple — required — (map)

        Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.

        • FieldToMatch — required — (map)

          Specifies where in a web request to look for snippets of malicious SQL code.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TextTransformation — required — (String)

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          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 to perform any text transformations.

          Possible values include:
          • "NONE"
          • "COMPRESS_WHITE_SPACE"
          • "HTML_ENTITY_DECODE"
          • "LOWERCASE"
          • "CMD_LINE"
          • "URL_DECODE"

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

  • A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

  • The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

  • For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

  • The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

To create and configure a WebACL, perform the following steps:

  1. Create and update the predicates that you want to include in Rules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.

  2. Create and update the Rules that you want to include in the WebACL. For more information, see CreateRule and UpdateRule.

  3. Create a WebACL. See CreateWebACL.

  4. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

  5. Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

    The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule, you can exclude specific rules from that rule group.

    If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules.

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update a Web ACL


/* The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  DefaultAction: {
   Type: "ALLOW"
  }, 
  Updates: [
     {
    Action: "DELETE", 
    ActivatedRule: {
     Action: {
      Type: "ALLOW"
     }, 
     Priority: 1, 
     RuleId: "WAFRule-1-Example"
    }
   }
  ], 
  WebACLId: "webacl-1472061481310"
 };
 waf.updateWebACL(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateWebACL operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  WebACLId: 'STRING_VALUE', /* required */
  DefaultAction: {
    Type: BLOCK | ALLOW | COUNT /* required */
  },
  Updates: [
    {
      Action: INSERT | DELETE, /* required */
      ActivatedRule: { /* required */
        Priority: 'NUMBER_VALUE', /* required */
        RuleId: 'STRING_VALUE', /* required */
        Action: {
          Type: BLOCK | ALLOW | COUNT /* required */
        },
        ExcludedRules: [
          {
            RuleId: 'STRING_VALUE' /* required */
          },
          /* more items */
        ],
        OverrideAction: {
          Type: NONE | COUNT /* required */
        },
        Type: REGULAR | RATE_BASED | GROUP
      }
    },
    /* more items */
  ]
};
waf.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: {}) —
    • WebACLId — (String)

      The WebACLId of the WebACL that you want to update. WebACLId is returned by CreateWebACL and by ListWebACLs.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of updates to make to the WebACL.

      An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For more information, see the applicable data types:

      • WebACLUpdate: Contains Action and ActivatedRule

      • ActivatedRule: Contains Action, OverrideAction, Priority, RuleId, and Type. ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

      • WafAction: Contains Type

      • Action — required — (String)

        Specifies whether to insert a Rule into or delete a Rule from a WebACL.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • ActivatedRule — required — (map)

        The ActivatedRule object in an UpdateWebACL request specifies a Rule that you want to insert or delete, the priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK, or COUNT).

        • Priority — required — (Integer)

          Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower value for Priority are evaluated before Rules with a higher value. The value must be a unique integer. If you add multiple Rules to a WebACL, the values don't need to be consecutive.

        • RuleId — required — (String)

          The RuleId for a Rule. You use RuleId to get more information about a Rule (see GetRule), update a Rule (see UpdateRule), insert a Rule into a WebACL or delete a one from a WebACL (see UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).

          RuleId is returned by CreateRule and by ListRules.

        • Action — (map)

          Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the Rule. Valid values for Action include the following:

          • ALLOW: CloudFront responds with the requested object.

          • BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.

          • COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then continues to inspect the web request based on the remaining rules in the web ACL.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case, you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

            • ALLOW: AWS WAF allows requests

            • BLOCK: AWS WAF blocks requests

            • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

            Possible values include:
            • "BLOCK"
            • "ALLOW"
            • "COUNT"
        • OverrideAction — (map)

          Use the OverrideAction to test your RuleGroup.

          Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction to None, the RuleGroup will block a request if any individual rule in the RuleGroup matches the request and is configured to block that request. However if you first want to test the RuleGroup, set the OverrideAction to Count. The RuleGroup will then override any block action specified by individual rules contained within the group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted requests using GetSampledRequests.

          ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a WebACL. In this case you do not use ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.

          • Type — required — (String)

            COUNT overrides the action specified by the individual rule within a RuleGroup . If set to NONE, the rule's action will take place.

            Possible values include:
            • "NONE"
            • "COUNT"
        • Type — (String)

          The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type, the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID, which does not exist.

          Possible values include:
          • "REGULAR"
          • "RATE_BASED"
          • "GROUP"
        • ExcludedRules — (Array<map>)

          An array of rules to exclude from a rule group. This is applicable only when the ActivatedRule refers to a RuleGroup.

          Sometimes it is necessary to troubleshoot rule groups that are blocking traffic unexpectedly (false positives). One troubleshooting technique is to identify the specific rule within the rule group that is blocking the legitimate traffic and then disable (exclude) that particular rule. You can exclude rules from both your own rule groups and AWS Marketplace rule groups that have been associated with a web ACL.

          Specifying ExcludedRules does not remove those rules from the rule group. Rather, it changes the action for the rules to COUNT. Therefore, requests that match an ExcludedRule are counted but not blocked. The RuleGroup owner will receive COUNT metrics for each ExcludedRule.

          If you want to exclude rules from a rule group that is already associated with a web ACL, perform the following steps:

          1. Use the AWS WAF logs to identify the IDs of the rules that you want to exclude. For more information about the logs, see Logging Web ACL Traffic Information.

          2. Submit an UpdateWebACL request that has two actions:

            • The first action deletes the existing rule group from the web ACL. That is, in the UpdateWebACL request, the first Updates:Action should be DELETE and Updates:ActivatedRule:RuleId should be the rule group that contains the rules that you want to exclude.

            • The second action inserts the same rule group back in, but specifying the rules to exclude. That is, the second Updates:Action should be INSERT, Updates:ActivatedRule:RuleId should be the rule group that you just removed, and ExcludedRules should contain the rules that you want to exclude.

          • RuleId — required — (String)

            The unique identifier for the rule to exclude from the rule group.

    • DefaultAction — (map)

      A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.

      • Type — required — (String)

        Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid settings include the following:

        • ALLOW: AWS WAF allows requests

        • BLOCK: AWS WAF blocks requests

        • COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule. AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify COUNT for the default action for a WebACL.

        Possible values include:
        • "BLOCK"
        • "ALLOW"
        • "COUNT"

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateWebACL request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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

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

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

  • Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

  • FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

  • TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

    You can only specify a single type of TextTransformation.

You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure an XssMatchSet, perform the following steps:

  1. Submit a CreateXssMatchSet request.

  2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

  3. Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Service Reference:

Examples:

To update an XSS match set


/* The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5. */

 var params = {
  ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f", 
  Updates: [
     {
    Action: "DELETE", 
    XssMatchTuple: {
     FieldToMatch: {
      Type: "QUERY_STRING"
     }, 
     TextTransformation: "URL_DECODE"
    }
   }
  ], 
  XssMatchSetId: "example1ds3t-46da-4fdb-b8d5-abc321j569j5"
 };
 waf.updateXssMatchSet(params, function(err, data) {
   if (err) console.log(err, err.stack); // an error occurred
   else     console.log(data);           // successful response
   /*
   data = {
    ChangeToken: "abcd12f2-46da-4fdb-b8d5-fbd4c466928f"
   }
   */
 });

Calling the updateXssMatchSet operation

var params = {
  ChangeToken: 'STRING_VALUE', /* required */
  Updates: [ /* required */
    {
      Action: INSERT | DELETE, /* required */
      XssMatchTuple: { /* required */
        FieldToMatch: { /* required */
          Type: URI | QUERY_STRING | HEADER | METHOD | BODY | SINGLE_QUERY_ARG | ALL_QUERY_ARGS, /* required */
          Data: 'STRING_VALUE'
        },
        TextTransformation: NONE | COMPRESS_WHITE_SPACE | HTML_ENTITY_DECODE | LOWERCASE | CMD_LINE | URL_DECODE /* required */
      }
    },
    /* more items */
  ],
  XssMatchSetId: 'STRING_VALUE' /* required */
};
waf.updateXssMatchSet(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: {}) —
    • XssMatchSetId — (String)

      The XssMatchSetId of the XssMatchSet that you want to update. XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.

    • ChangeToken — (String)

      The value returned by the most recent call to GetChangeToken.

    • Updates — (Array<map>)

      An array of XssMatchSetUpdate objects that you want to insert into or delete from an XssMatchSet. For more information, see the applicable data types:

      • Action — required — (String)

        Specify INSERT to add an XssMatchSetUpdate to an XssMatchSet. Use DELETE to remove an XssMatchSetUpdate from an XssMatchSet.

        Possible values include:
        • "INSERT"
        • "DELETE"
      • XssMatchTuple — required — (map)

        Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.

        • FieldToMatch — required — (map)

          Specifies where in a web request to look for cross-site scripting attacks.

          • Type — required — (String)

            The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:

            • HEADER: A specified request header, for example, the value of the User-Agent or Referer header. If you choose HEADER for the type, specify the name of the header in Data.

            • METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin to perform. Amazon CloudFront supports the following methods: DELETE, GET, HEAD, OPTIONS, PATCH, POST, and PUT.

            • QUERY_STRING: A query string, which is the part of a URL that appears after a ? character, if any.

            • URI: The part of a web request that identifies a resource, for example, /images/daily-ad.jpg.

            • BODY: 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. The request body immediately follows the request headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For more information, see CreateSizeConstraintSet.

            • SINGLE_QUERY_ARG: The parameter in the query string that you will inspect, such as UserName or SalesRegion. The maximum length for SINGLE_QUERY_ARG is 30 characters.

            • ALL_QUERY_ARGS: Similar to SINGLE_QUERY_ARG, but rather than inspecting a single parameter, AWS WAF will inspect all parameters within the query for the value or regex pattern that you specify in TargetString.

            Possible values include:
            • "URI"
            • "QUERY_STRING"
            • "HEADER"
            • "METHOD"
            • "BODY"
            • "SINGLE_QUERY_ARG"
            • "ALL_QUERY_ARGS"
          • Data — (String)

            When the value of Type is HEADER, enter the name of the header that you want AWS WAF to search, for example, User-Agent or Referer. The name of the header is not case sensitive.

            When the value of Type is SINGLE_QUERY_ARG, enter the name of the parameter that you want AWS WAF to search, for example, UserName or SalesRegion. The parameter name is not case sensitive.

            If the value of Type is any other value, omit Data.

        • TextTransformation — required — (String)

          Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch before inspecting a request for a match.

          You can only specify a single type of TextTransformation.

          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 to perform any text transformations.

          Possible values include:
          • "NONE"
          • "COMPRESS_WHITE_SPACE"
          • "HTML_ENTITY_DECODE"
          • "LOWERCASE"
          • "CMD_LINE"
          • "URL_DECODE"

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:

      • ChangeToken — (String)

        The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use this value to query the status of the request. For more information, see GetChangeTokenStatus.

Returns:

  • (AWS.Request) —

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