/ 
Paws-0.32
River stage two • 9 direct dependents • 11 total dependents
/ Paws::WAF

NAME

Paws::WAF - Perl Interface to AWS AWS WAF

SYNOPSIS

use Paws;

my $obj = Paws->service('WAF');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

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.

METHODS

CreateByteMatchSet(ChangeToken => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateByteMatchSet

Returns: a Paws::WAF::CreateByteMatchSetResponse instance

Creates a C<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 C<User-Agent> header or the query string. For example,
you can create a C<ByteMatchSet> that matches any requests with
C<User-Agent> headers that contain the string C<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.

CreateIPSet(ChangeToken => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateIPSet

Returns: a Paws::WAF::CreateIPSetResponse instance

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

CreateRule(ChangeToken => Str, MetricName => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateRule

Returns: a Paws::WAF::CreateRuleResponse instance

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

CreateSizeConstraintSet(ChangeToken => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateSizeConstraintSet

Returns: a Paws::WAF::CreateSizeConstraintSetResponse instance

Creates a C<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 C<User-Agent> header or the length of
the query string. For example, you can create a C<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.

CreateSqlInjectionMatchSet(ChangeToken => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateSqlInjectionMatchSet

Returns: a Paws::WAF::CreateSqlInjectionMatchSetResponse instance

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.

CreateWebACL(ChangeToken => Str, DefaultAction => Paws::WAF::WafAction, MetricName => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateWebACL

Returns: a Paws::WAF::CreateWebACLResponse instance

Creates a C<WebACL>, which contains the C<Rules> that identify the
CloudFront web requests that you want to allow, block, or count. AWS
WAF evaluates C<Rules> in order based on the value of C<Priority> for
each C<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.

CreateXssMatchSet(ChangeToken => Str, Name => Str)

Each argument is described in detail in: Paws::WAF::CreateXssMatchSet

Returns: a Paws::WAF::CreateXssMatchSetResponse instance

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.

DeleteByteMatchSet(ByteMatchSetId => Str, ChangeToken => Str)

Each argument is described in detail in: Paws::WAF::DeleteByteMatchSet

Returns: a Paws::WAF::DeleteByteMatchSetResponse instance

Permanently deletes a ByteMatchSet. You can't delete a C<ByteMatchSet>
if it's still used in any C<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.

DeleteIPSet(ChangeToken => Str, IPSetId => Str)

Each argument is described in detail in: Paws::WAF::DeleteIPSet

Returns: a Paws::WAF::DeleteIPSetResponse instance

Permanently deletes an IPSet. You can't delete an C<IPSet> if it's
still used in any C<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.

DeleteRule(ChangeToken => Str, RuleId => Str)

Each argument is described in detail in: Paws::WAF::DeleteRule

Returns: a Paws::WAF::DeleteRuleResponse instance

Permanently deletes a Rule. You can't delete a C<Rule> if it's still
used in any C<WebACL> objects or if it still includes any predicates,
such as C<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.

DeleteSizeConstraintSet(ChangeToken => Str, SizeConstraintSetId => Str)

Each argument is described in detail in: Paws::WAF::DeleteSizeConstraintSet

Returns: a Paws::WAF::DeleteSizeConstraintSetResponse instance

Permanently deletes a SizeConstraintSet. You can't delete a
C<SizeConstraintSet> if it's still used in any C<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.

DeleteSqlInjectionMatchSet(ChangeToken => Str, SqlInjectionMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::DeleteSqlInjectionMatchSet

Returns: a Paws::WAF::DeleteSqlInjectionMatchSetResponse instance

Permanently deletes a SqlInjectionMatchSet. You can't delete a
C<SqlInjectionMatchSet> if it's still used in any C<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.

DeleteWebACL(ChangeToken => Str, WebACLId => Str)

Each argument is described in detail in: Paws::WAF::DeleteWebACL

Returns: a Paws::WAF::DeleteWebACLResponse instance

Permanently deletes a WebACL. You can't delete a C<WebACL> if it still
contains any C<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.

DeleteXssMatchSet(ChangeToken => Str, XssMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::DeleteXssMatchSet

Returns: a Paws::WAF::DeleteXssMatchSetResponse instance

Permanently deletes an XssMatchSet. You can't delete an C<XssMatchSet>
if it's still used in any C<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.

GetByteMatchSet(ByteMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::GetByteMatchSet

Returns: a Paws::WAF::GetByteMatchSetResponse instance

Returns the ByteMatchSet specified by C<ByteMatchSetId>.

GetChangeToken()

Each argument is described in detail in: Paws::WAF::GetChangeToken

Returns: a Paws::WAF::GetChangeTokenResponse instance

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.

GetChangeTokenStatus(ChangeToken => Str)

Each argument is described in detail in: Paws::WAF::GetChangeTokenStatus

Returns: a Paws::WAF::GetChangeTokenStatusResponse instance

Returns the status of a C<ChangeToken> that you got by calling
GetChangeToken. C<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.

GetIPSet(IPSetId => Str)

Each argument is described in detail in: Paws::WAF::GetIPSet

Returns: a Paws::WAF::GetIPSetResponse instance

Returns the IPSet that is specified by C<IPSetId>.

GetRule(RuleId => Str)

Each argument is described in detail in: Paws::WAF::GetRule

Returns: a Paws::WAF::GetRuleResponse instance

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

GetSampledRequests(MaxItems => Int, RuleId => Str, TimeWindow => Paws::WAF::TimeWindow, WebAclId => Str)

Each argument is described in detail in: Paws::WAF::GetSampledRequests

Returns: a Paws::WAF::GetSampledRequestsResponse instance

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.

GetSizeConstraintSet(SizeConstraintSetId => Str)

Each argument is described in detail in: Paws::WAF::GetSizeConstraintSet

Returns: a Paws::WAF::GetSizeConstraintSetResponse instance

Returns the SizeConstraintSet specified by C<SizeConstraintSetId>.

GetSqlInjectionMatchSet(SqlInjectionMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::GetSqlInjectionMatchSet

Returns: a Paws::WAF::GetSqlInjectionMatchSetResponse instance

Returns the SqlInjectionMatchSet that is specified by
C<SqlInjectionMatchSetId>.

GetWebACL(WebACLId => Str)

Each argument is described in detail in: Paws::WAF::GetWebACL

Returns: a Paws::WAF::GetWebACLResponse instance

Returns the WebACL that is specified by C<WebACLId>.

GetXssMatchSet(XssMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::GetXssMatchSet

Returns: a Paws::WAF::GetXssMatchSetResponse instance

Returns the XssMatchSet that is specified by C<XssMatchSetId>.

ListByteMatchSets([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListByteMatchSets

Returns: a Paws::WAF::ListByteMatchSetsResponse instance

Returns an array of ByteMatchSetSummary objects.

ListIPSets([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListIPSets

Returns: a Paws::WAF::ListIPSetsResponse instance

Returns an array of IPSetSummary objects in the response.

ListRules([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListRules

Returns: a Paws::WAF::ListRulesResponse instance

Returns an array of RuleSummary objects.

ListSizeConstraintSets([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListSizeConstraintSets

Returns: a Paws::WAF::ListSizeConstraintSetsResponse instance

Returns an array of SizeConstraintSetSummary objects.

ListSqlInjectionMatchSets([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListSqlInjectionMatchSets

Returns: a Paws::WAF::ListSqlInjectionMatchSetsResponse instance

Returns an array of SqlInjectionMatchSet objects.

ListWebACLs([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListWebACLs

Returns: a Paws::WAF::ListWebACLsResponse instance

Returns an array of WebACLSummary objects in the response.

ListXssMatchSets([Limit => Int, NextMarker => Str])

Each argument is described in detail in: Paws::WAF::ListXssMatchSets

Returns: a Paws::WAF::ListXssMatchSetsResponse instance

Returns an array of XssMatchSet objects.

UpdateByteMatchSet(ByteMatchSetId => Str, ChangeToken => Str, Updates => ArrayRef[Paws::WAF::ByteMatchSetUpdate])

Each argument is described in detail in: Paws::WAF::UpdateByteMatchSet

Returns: a Paws::WAF::UpdateByteMatchSetResponse instance

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet.
For each C<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.

UpdateIPSet(ChangeToken => Str, IPSetId => Str, Updates => ArrayRef[Paws::WAF::IPSetUpdate])

Each argument is described in detail in: Paws::WAF::UpdateIPSet

Returns: a Paws::WAF::UpdateIPSetResponse instance

Inserts or deletes IPSetDescriptor objects in an C<IPSet>. For each
C<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 /8, /16, /24, and /32 IP address ranges for IPv4, and /24, /32, /48, /56, /64 and /128 for IPv6. 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.

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

UpdateRule(ChangeToken => Str, RuleId => Str, Updates => ArrayRef[Paws::WAF::RuleUpdate])

Each argument is described in detail in: Paws::WAF::UpdateRule

Returns: a Paws::WAF::UpdateRuleResponse instance

Inserts or deletes Predicate objects in a C<Rule>. Each C<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 C<Rule>, a request must match all
of the specifications to be allowed, blocked, or counted. For example,
suppose you add the following to a C<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.

UpdateSizeConstraintSet(ChangeToken => Str, SizeConstraintSetId => Str, Updates => ArrayRef[Paws::WAF::SizeConstraintSetUpdate])

Each argument is described in detail in: Paws::WAF::UpdateSizeConstraintSet

Returns: a Paws::WAF::UpdateSizeConstraintSetResponse instance

Inserts or deletes SizeConstraint objects (filters) in a
SizeConstraintSet. For each C<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.

UpdateSqlInjectionMatchSet(ChangeToken => Str, SqlInjectionMatchSetId => Str, Updates => ArrayRef[Paws::WAF::SqlInjectionMatchSetUpdate])

Each argument is described in detail in: Paws::WAF::UpdateSqlInjectionMatchSet

Returns: a Paws::WAF::UpdateSqlInjectionMatchSetResponse instance

Inserts or deletes SqlInjectionMatchTuple objects (filters) in a
SqlInjectionMatchSet. For each C<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.

UpdateWebACL(ChangeToken => Str, WebACLId => Str, [DefaultAction => Paws::WAF::WafAction, Updates => ArrayRef[Paws::WAF::WebACLUpdate]])

Each argument is described in detail in: Paws::WAF::UpdateWebACL

Returns: a Paws::WAF::UpdateWebACLResponse instance

Inserts or deletes ActivatedRule objects in a C<WebACL>. Each C<Rule>
identifies web requests that you want to allow, block, or count. When
you update a C<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.

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.

UpdateXssMatchSet(ChangeToken => Str, Updates => ArrayRef[Paws::WAF::XssMatchSetUpdate], XssMatchSetId => Str)

Each argument is described in detail in: Paws::WAF::UpdateXssMatchSet

Returns: a Paws::WAF::UpdateXssMatchSetResponse instance

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet.
For each C<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.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllByteMatchSets(sub { },[Limit => Int, NextMarker => Str])

ListAllByteMatchSets([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- ByteMatchSets, passing the object as the first parameter, and the string 'ByteMatchSets' as the second parameter

If not, it will return a a Paws::WAF::ListByteMatchSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllIPSets(sub { },[Limit => Int, NextMarker => Str])

ListAllIPSets([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- IPSets, passing the object as the first parameter, and the string 'IPSets' as the second parameter

If not, it will return a a Paws::WAF::ListIPSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllRules(sub { },[Limit => Int, NextMarker => Str])

ListAllRules([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- Rules, passing the object as the first parameter, and the string 'Rules' as the second parameter

If not, it will return a a Paws::WAF::ListRulesResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSizeConstraintSets(sub { },[Limit => Int, NextMarker => Str])

ListAllSizeConstraintSets([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- SizeConstraintSets, passing the object as the first parameter, and the string 'SizeConstraintSets' as the second parameter

If not, it will return a a Paws::WAF::ListSizeConstraintSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllSqlInjectionMatchSets(sub { },[Limit => Int, NextMarker => Str])

ListAllSqlInjectionMatchSets([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- SqlInjectionMatchSets, passing the object as the first parameter, and the string 'SqlInjectionMatchSets' as the second parameter

If not, it will return a a Paws::WAF::ListSqlInjectionMatchSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllWebACLs(sub { },[Limit => Int, NextMarker => Str])

ListAllWebACLs([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- WebACLs, passing the object as the first parameter, and the string 'WebACLs' as the second parameter

If not, it will return a a Paws::WAF::ListWebACLsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllXssMatchSets(sub { },[Limit => Int, NextMarker => Str])

ListAllXssMatchSets([Limit => Int, NextMarker => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- XssMatchSets, passing the object as the first parameter, and the string 'XssMatchSets' as the second parameter

If not, it will return a a Paws::WAF::ListXssMatchSetsResponse instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues