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. 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 ChangeTokenparameter of aCreateByteMatchSetrequest.
- 2. Submit a CreateByteMatchSetrequest.
- 3. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateByteMatchSetrequest.
- 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 ChangeTokenparameter of aCreateIPSetrequest.
- 2. Submit a CreateIPSetrequest.
- 3. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateIPSet request.
- 4. Submit an UpdateIPSetrequest 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 - IPSetthat matches the IP address- 192.0.2.44/32
- A - ByteMatchSetthat matches- BadBotin the- User-Agentheader
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 ChangeTokenparameter of aCreateRulerequest.
- 3. Submit a CreateRulerequest.
- 4. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateRule request.
- 5. Submit an UpdateRulerequest to specify the predicates that you want to include in theRule.
- 6. Create and update a WebACLthat contains theRule. 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 ChangeTokenparameter of aCreateSizeConstraintSetrequest.
- 2. Submit a CreateSizeConstraintSetrequest.
- 3. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of anUpdateSizeConstraintSetrequest.
- 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 ChangeTokenparameter of aCreateSqlInjectionMatchSetrequest.
- 2. Submit a CreateSqlInjectionMatchSetrequest.
- 3. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter 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 ByteMatchSetobjects and other predicates that you want to include inRules. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
- 2. Create and update the Rulesthat you want to include in theWebACL. For more information, see CreateRule and UpdateRule.
- 3. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aCreateWebACLrequest.
- 4. Submit a CreateWebACLrequest.
- 5. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateWebACL request.
- 6. Submit an UpdateWebACL request to specify the Rulesthat you want to include in theWebACL, to specify the default action, and to associate theWebACLwith 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 ChangeTokenparameter of aCreateXssMatchSetrequest.
- 2. Submit a CreateXssMatchSetrequest.
- 3. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter 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 ByteMatchSetto remove filters, if any. For more information, see UpdateByteMatchSet.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteByteMatchSetrequest.
- 3. Submit a DeleteByteMatchSetrequest.
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 IPSetto remove IP address ranges, if any. For more information, see UpdateIPSet.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteIPSetrequest.
- 3. Submit a DeleteIPSetrequest.
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 Ruleto remove predicates, if any. For more information, see UpdateRule.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteRulerequest.
- 3. Submit a DeleteRulerequest.
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 SizeConstraintSetto remove filters, if any. For more information, see UpdateSizeConstraintSet.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteSizeConstraintSetrequest.
- 3. Submit a DeleteSizeConstraintSetrequest.
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 SqlInjectionMatchSetto remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteSqlInjectionMatchSetrequest.
- 3. Submit a DeleteSqlInjectionMatchSetrequest.
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 WebACLto removeRules, if any. For more information, see UpdateWebACL.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteWebACLrequest.
- 3. Submit a DeleteWebACLrequest.
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 XssMatchSetto remove filters, if any. For more information, see UpdateXssMatchSet.
- 2. Use GetChangeToken to get the change token that you provide in the ChangeTokenparameter of aDeleteXssMatchSetrequest.
- 3. Submit a DeleteXssMatchSetrequest.
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 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.
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 - ByteMatchSetUpdateobject, 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-Agentheader.
- 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 - TargetStringin 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 ChangeTokenparameter of anUpdateByteMatchSetrequest.
- 3. Submit an UpdateByteMatchSetrequest 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 - IPSetDescriptorobject, 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.0to- 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.
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 ChangeTokenparameter of an UpdateIPSet request.
- 3. Submit an UpdateIPSetrequest 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 - ByteMatchSetthat matches the value- BadBotin the- User-Agentheader
- An - IPSetthat 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 GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateRule request.
- 4. Submit an UpdateRulerequest to add predicates to theRule.
- 5. Create and update a WebACLthat contains theRule. 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 - SizeConstraintSetUpdateobject, 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-Agentheader.
- 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 - 8192bytes of your request to AWS WAF.
- A - ComparisonOperatorused 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 ChangeTokenparameter of anUpdateSizeConstraintSetrequest.
- 3. Submit an UpdateSizeConstraintSetrequest 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 ChangeTokenparameter of an UpdateIPSet request.
- 3. Submit an UpdateSqlInjectionMatchSetrequest 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- ALLOWor- BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the- Rulesin a- WebACL.
- The - Rulesthat you want to add and/or delete. If you want to replace one- Rulewith another, you delete the existing- Ruleand 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 - Rulesin a- WebACL. If you add more than one- Ruleto a- WebACL, AWS WAF evaluates each request against the- Rulesin order based on the value of- Priority. (The- Rulethat has the lowest value for- Priorityis evaluated first.) When a web request matches all of the predicates (such as- ByteMatchSetsand- IPSets) in a- Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining- Rulesin 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 Rulesthat you want to include in theWebACL. For more information, see CreateRule and UpdateRule.
- 3. Create a WebACL. See CreateWebACL.
- 4. Use GetChangeTokento get the change token that you provide in theChangeTokenparameter of an UpdateWebACL request.
- 5. Submit an UpdateWebACLrequest to specify theRulesthat you want to include in theWebACL, to specify the default action, and to associate theWebACLwith 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 ChangeTokenparameter of an UpdateIPSet request.
- 3. Submit an UpdateXssMatchSetrequest 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.
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