aws-elixir v0.1.0 AWS.WAF

This is the AWS WAF API Reference. 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.

Summary

Functions

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

Creates an IPSet, which you use to specify which web requests 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

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 you add the following to a Rule

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

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

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

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

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)

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

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

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)

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

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

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

Returns the ByteMatchSet specified by ByteMatchSetId

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

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

Returns the IPSet that is specified by IPSetId

Returns the Rule that is specified by the RuleId that you included in the GetRule 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 100 requests, and you can specify any time range in the previous three hours

Returns the SizeConstraintSet specified by SizeConstraintSetId

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId

Returns the WebACL that is specified by WebACLId

Returns the XssMatchSet that is specified by XssMatchSetId

Returns an array of ByteMatchSetSummary objects

Returns an array of IPSetSummary objects in the response

Returns an array of RuleSummary objects

Returns an array of SizeConstraintSetSummary objects

Returns an array of SqlInjectionMatchSet objects

Returns an array of WebACLSummary objects in the response

Returns an array of XssMatchSet objects

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values

Inserts or deletes IPSetDescriptor objects in an IPSet. For each IPSetDescriptor object, you specify the following values

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 you add the following to a Rule

Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each SizeConstraint object, you specify the following values

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each SqlInjectionMatchTuple object, you specify the following values

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

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values

Functions

create_byte_match_set(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_i_p_set(client, input, options \\ [])

Creates an IPSet, which you use to specify which web requests 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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_rule(client, input, options \\ [])

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 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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_size_constraint_set(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_sql_injection_match_set(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_web_a_c_l(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
create_xss_match_set(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
delete_byte_match_set(client, input, options \\ [])

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.
delete_i_p_set(client, input, options \\ [])

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.
delete_rule(client, input, options \\ [])

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.
delete_size_constraint_set(client, input, options \\ [])

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.
delete_sql_injection_match_set(client, input, options \\ [])

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.
delete_web_a_c_l(client, input, options \\ [])

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.
delete_xss_match_set(client, input, options \\ [])

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.
get_byte_match_set(client, input, options \\ [])

Returns the ByteMatchSet specified by ByteMatchSetId.

get_change_token(client, input, options \\ [])

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.

get_change_token_status(client, input, options \\ [])

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.
  • `IN_SYNC`: Propagation is complete.
get_i_p_set(client, input, options \\ [])

Returns the IPSet that is specified by IPSetId.

get_rule(client, input, options \\ [])

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

get_sampled_requests(client, input, options \\ [])

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

get_size_constraint_set(client, input, options \\ [])

Returns the SizeConstraintSet specified by SizeConstraintSetId.

get_sql_injection_match_set(client, input, options \\ [])

Returns the SqlInjectionMatchSet that is specified by SqlInjectionMatchSetId.

get_web_a_c_l(client, input, options \\ [])

Returns the WebACL that is specified by WebACLId.

get_xss_match_set(client, input, options \\ [])

Returns the XssMatchSet that is specified by XssMatchSetId.

list_byte_match_sets(client, input, options \\ [])

Returns an array of ByteMatchSetSummary objects.

list_i_p_sets(client, input, options \\ [])

Returns an array of IPSetSummary objects in the response.

list_rules(client, input, options \\ [])

Returns an array of RuleSummary objects.

list_size_constraint_sets(client, input, options \\ [])

Returns an array of SizeConstraintSetSummary objects.

list_sql_injection_match_sets(client, input, options \\ [])

Returns an array of SqlInjectionMatchSet objects.

list_web_a_c_ls(client, input, options \\ [])

Returns an array of WebACLSummary objects in the response.

list_xss_match_sets(client, input, options \\ [])

Returns an array of XssMatchSet objects.

update_byte_match_set(client, input, options \\ [])

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](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_i_p_set(client, input, options \\ [])

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`.
  • 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 /8, /16, /24, and /32 IP address ranges. For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing). 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. For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_rule(client, input, options \\ [])

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 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](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_size_constraint_set(client, input, options \\ [])

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.
  • 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](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_sql_injection_match_set(client, input, options \\ [])

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, the name of the header.
  • `TextTransformation`: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.
You use `SqlInjectionMatchSet` objects to specify which CloudFront requests 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](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_web_a_c_l(client, input, options \\ [])

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 and/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 of 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.
  • The CloudFront distribution that you want to associate with the `WebACL`.
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.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide](http://docs.aws.amazon.com/waf/latest/developerguide/).
update_xss_match_set(client, input, options \\ [])

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 a `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, the name of the header.
  • `TextTransformation`: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.
You use `XssMatchSet` objects to specify which CloudFront requests 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](http://docs.aws.amazon.com/waf/latest/developerguide/).