Integer priority
Specifies the order in which the Rules in a WebACL are evaluated. Rules with a lower
value for Priority are evaluated before Rules with a higher value. The value must be a
unique integer. If you add multiple Rules to a WebACL, the values don't need to be
consecutive.
String ruleId
The RuleId for a Rule. You use RuleId to get more information about a
Rule (see GetRule), update a Rule (see UpdateRule), insert a
Rule into a WebACL or delete a one from a WebACL (see
UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
WafAction action
Specifies the action that CloudFront or AWS WAF takes when a web request matches the conditions in the
Rule. Valid values for Action include the following:
ALLOW: CloudFront responds with the requested object.
BLOCK: CloudFront responds with an HTTP 403 (Forbidden) status code.
COUNT: AWS WAF increments a counter of requests that match the conditions in the rule and then
continues to inspect the web request based on the remaining rules in the web ACL.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
WebACL. In this case you do not use ActivatedRule|Action. For all other update
requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
WafOverrideAction overrideAction
Use the OverrideAction to test your RuleGroup.
Any rule in a RuleGroup can potentially block a request. If you set the OverrideAction
to None, the RuleGroup will block a request if any individual rule in the
RuleGroup matches the request and is configured to block that request. However if you first want to
test the RuleGroup, set the OverrideAction to Count. The
RuleGroup will then override any block action specified by individual rules contained within the
group. Instead of blocking matching requests, those requests will be counted. You can view a record of counted
requests using GetSampledRequests.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
WebACL. In this case you do not use ActivatedRule|Action. For all other update
requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
String type
The rule type, either REGULAR, as defined by Rule, RATE_BASED, as defined by
RateBasedRule, or GROUP, as defined by RuleGroup. The default is REGULAR. Although
this field is optional, be aware that if you try to add a RATE_BASED rule to a web ACL without setting the type,
the UpdateWebACL request will fail because the request tries to add a REGULAR rule with the specified ID,
which does not exist.
String byteMatchSetId
The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get
information about a ByteMatchSet (see GetByteMatchSet), update a ByteMatchSet
(see UpdateByteMatchSet), insert a ByteMatchSet into a Rule or delete one from a
Rule (see UpdateRule), and delete a ByteMatchSet from AWS WAF (see
DeleteByteMatchSet).
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
String name
A friendly name or description of the ByteMatchSet. You can't change Name after you create a
ByteMatchSet.
List<E> byteMatchTuples
Specifies the bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to search for in web requests, the location in requests that you want AWS WAF to search, and other settings.
String byteMatchSetId
The ByteMatchSetId for a ByteMatchSet. You use ByteMatchSetId to get
information about a ByteMatchSet, update a ByteMatchSet, remove a
ByteMatchSet from a Rule, and delete a ByteMatchSet from AWS WAF.
ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.
String name
A friendly name or description of the ByteMatchSet. You can't change Name after you create a
ByteMatchSet.
String action
Specifies whether to insert or delete a ByteMatchTuple.
ByteMatchTuple byteMatchTuple
Information about the part of a web request that you want AWS WAF to inspect and the value that you want AWS WAF
to search for. If you specify DELETE for the value of Action, the
ByteMatchTuple values must exactly match the values in the ByteMatchTuple that you want
to delete from the ByteMatchSet.
FieldToMatch fieldToMatch
The part of a web request that you want AWS WAF to search, such as a specified header or a query string. For more information, see FieldToMatch.
ByteBuffer targetString
The value that you want AWS WAF to search for. AWS WAF searches for the specified string in the part of web
requests that you specified in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the values that you specified for FieldToMatch:
HEADER: The value that you want AWS WAF to search for in the request header that you specified in
FieldToMatch, for example, the value of the User-Agent or Referer header.
METHOD: The HTTP method, which indicates the type of operation specified in the request. CloudFront
supports the following methods: DELETE, GET, HEAD, OPTIONS,
PATCH, POST, and PUT.
QUERY_STRING: The value that you want AWS WAF to search for in the query string, which is the part
of a URL that appears after a ? character.
URI: The value that you want AWS WAF to search for in the part of a URL that identifies a resource,
for example, /images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web
server as the HTTP request body, such as data from a form. The request body immediately follows the request
headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for
inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For
more information, see CreateSizeConstraintSet.
If TargetString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is
User-Agent. If you want to search the User-Agent header for the value
BadBot, you base64-encode BadBot using MIME base64 encoding and include the resulting
value, QmFkQm90, in the value of TargetString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
String textTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on TargetString
before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
String positionalConstraint
Within the portion of a web request that you want to search (for example, in the query string, if any), specify where you want AWS WAF to search. Valid values include the following:
CONTAINS
The specified part of the web request must include the value of TargetString, but the location
doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of TargetString, and
TargetString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
addition, TargetString must be a word, which means one of the following:
TargetString exactly matches the value of the specified part of the web request, such as the value
of a header.
TargetString is at the beginning of the specified part of the web request and is followed by a
character other than an alphanumeric character or underscore (_), for example, BadBot;.
TargetString is at the end of the specified part of the web request and is preceded by a character
other than an alphanumeric character or underscore (_), for example, ;BadBot.
TargetString is in the middle of the specified part of the web request and is preceded and followed
by characters other than alphanumeric characters or underscore (_), for example, -BadBot;.
EXACTLY
The value of the specified part of the web request must exactly match the value of TargetString.
STARTS_WITH
The value of TargetString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of TargetString must appear at the end of the specified part of the web request.
String name
A friendly name or description of the ByteMatchSet. You can't change Name after you create a
ByteMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
ByteMatchSet byteMatchSet
A ByteMatchSet that contains no ByteMatchTuple objects.
String changeToken
The ChangeToken that you used to submit the CreateByteMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the GeoMatchSet. You can't change Name after you create the
GeoMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
GeoMatchSet geoMatchSet
The GeoMatchSet returned in the CreateGeoMatchSet response. The GeoMatchSet
contains no GeoMatchConstraints.
String changeToken
The ChangeToken that you used to submit the CreateGeoMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the IPSet. You can't change Name after you create the
IPSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
IPSet iPSet
The IPSet returned in the CreateIPSet response.
String changeToken
The ChangeToken that you used to submit the CreateIPSet request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the RateBasedRule. You can't change the name of a
RateBasedRule after you create it.
String metricName
A friendly name or description for the metrics for this RateBasedRule. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the
metric after you create the RateBasedRule.
String rateKey
The field that AWS WAF uses to determine if requests are likely arriving from a single source and thus subject to
rate monitoring. The only valid value for RateKey is IP. IP indicates that
requests that arrive from the same IP address are subject to the RateLimit that is specified in the
RateBasedRule.
Long rateLimit
The maximum number of requests, which have an identical value in the field that is specified by
RateKey, allowed in a five-minute period. If the number of requests exceeds the
RateLimit and the other predicates specified in the rule are also met, AWS WAF triggers the action
that is specified for this rule.
String changeToken
The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
RateBasedRule rule
The RateBasedRule that is returned in the CreateRateBasedRule response.
String changeToken
The ChangeToken that you used to submit the CreateRateBasedRule request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the RegexMatchSet. You can't change Name after you create a
RegexMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
RegexMatchSet regexMatchSet
A RegexMatchSet that contains no RegexMatchTuple objects.
String changeToken
The ChangeToken that you used to submit the CreateRegexMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the RegexPatternSet. You can't change Name after you create
a RegexPatternSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
RegexPatternSet regexPatternSet
A RegexPatternSet that contains no objects.
String changeToken
The ChangeToken that you used to submit the CreateRegexPatternSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the RuleGroup. You can't change Name after you create a
RuleGroup.
String metricName
A friendly name or description for the metrics for this RuleGroup. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the
metric after you create the RuleGroup.
String changeToken
The value returned by the most recent call to GetChangeToken.
RuleGroup ruleGroup
An empty RuleGroup.
String changeToken
The ChangeToken that you used to submit the CreateRuleGroup request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the Rule. You can't change the name of a Rule after you
create it.
String metricName
A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric
characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the metric after you
create the Rule.
String changeToken
The value returned by the most recent call to GetChangeToken.
Rule rule
The Rule returned in the CreateRule response.
String changeToken
The ChangeToken that you used to submit the CreateRule request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the SizeConstraintSet. You can't change Name after you
create a SizeConstraintSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
SizeConstraintSet sizeConstraintSet
A SizeConstraintSet that contains no SizeConstraint objects.
String changeToken
The ChangeToken that you used to submit the CreateSizeConstraintSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description for the SqlInjectionMatchSet that you're creating. You can't change
Name after you create the SqlInjectionMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
SqlInjectionMatchSet sqlInjectionMatchSet
String changeToken
The ChangeToken that you used to submit the CreateSqlInjectionMatchSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description of the WebACL. You can't change Name after you create the
WebACL.
String metricName
A friendly name or description for the metrics for this WebACL. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change
MetricName after you create the WebACL.
WafAction defaultAction
The action that you want AWS WAF to take when a request doesn't match the criteria specified in any of the
Rule objects that are associated with the WebACL.
String changeToken
The value returned by the most recent call to GetChangeToken.
WebACL webACL
The WebACL returned in the CreateWebACL response.
String changeToken
The ChangeToken that you used to submit the CreateWebACL request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String name
A friendly name or description for the XssMatchSet that you're creating. You can't change
Name after you create the XssMatchSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
XssMatchSet xssMatchSet
An XssMatchSet.
String changeToken
The ChangeToken that you used to submit the CreateXssMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteByteMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String geoMatchSetId
The GeoMatchSetID of the GeoMatchSet that you want to delete. GeoMatchSetId is
returned by CreateGeoMatchSet and by ListGeoMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteGeoMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String iPSetId
The IPSetId of the IPSet that you want to delete. IPSetId is returned by
CreateIPSet and by ListIPSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteIPSet request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String resourceArn
The Amazon Resource Name (ARN) of the RuleGroup from which you want to delete the policy.
The user making the request must be the owner of the RuleGroup.
String ruleId
The RuleId of the RateBasedRule that you want to delete. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteRateBasedRule request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String regexMatchSetId
The RegexMatchSetId of the RegexMatchSet that you want to delete.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteRegexMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String regexPatternSetId
The RegexPatternSetId of the RegexPatternSet that you want to delete.
RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteRegexPatternSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String ruleGroupId
The RuleGroupId of the RuleGroup that you want to delete. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteRuleGroup request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String ruleId
The RuleId of the Rule that you want to delete. RuleId is returned by
CreateRule and by ListRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteRule request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String sizeConstraintSetId
The SizeConstraintSetId of the SizeConstraintSet that you want to delete.
SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteSizeConstraintSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete.
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteSqlInjectionMatchSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String webACLId
The WebACLId of the WebACL that you want to delete. WebACLId is returned by
CreateWebACL and by ListWebACLs.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteWebACL request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String xssMatchSetId
The XssMatchSetId of the XssMatchSet that you want to delete. XssMatchSetId is
returned by CreateXssMatchSet and by ListXssMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the DeleteXssMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String resourceArn
The ARN (Amazon Resource Name) of the resource from which the web ACL is being removed.
String type
The part of the web request that you want AWS WAF to search for a specified string. Parts of a request that you can search include the following:
HEADER: A specified request header, for example, the value of the User-Agent or
Referer header. If you choose HEADER for the type, specify the name of the header in
Data.
METHOD: The HTTP method, which indicated the type of operation that the request is asking the origin
to perform. Amazon CloudFront supports the following methods: DELETE, GET,
HEAD, OPTIONS, PATCH, POST, and PUT.
QUERY_STRING: A query string, which is the part of a URL that appears after a ?
character, if any.
URI: The part of a web request that identifies a resource, for example,
/images/daily-ad.jpg.
BODY: The part of a request that contains any additional data that you want to send to your web
server as the HTTP request body, such as data from a form. The request body immediately follows the request
headers. Note that only the first 8192 bytes of the request body are forwarded to AWS WAF for
inspection. To allow or block requests based on the length of the body, you can create a size constraint set. For
more information, see CreateSizeConstraintSet.
String data
When the value of Type is HEADER, enter the name of the header that you want AWS WAF to
search, for example, User-Agent or Referer. If the value of Type is any
other value, omit Data.
The name of the header is not case sensitive.
String geoMatchSetId
The GeoMatchSetId for an GeoMatchSet. You use GeoMatchSetId to get
information about a GeoMatchSet (see GeoMatchSet), update a GeoMatchSet (see
UpdateGeoMatchSet), insert a GeoMatchSet into a Rule or delete one from a
Rule (see UpdateRule), and delete a GeoMatchSet from AWS WAF (see
DeleteGeoMatchSet).
GeoMatchSetId is returned by CreateGeoMatchSet and by ListGeoMatchSets.
String name
A friendly name or description of the GeoMatchSet. You can't change the name of an
GeoMatchSet after you create it.
List<E> geoMatchConstraints
An array of GeoMatchConstraint objects, which contain the country that you want AWS WAF to search for.
String geoMatchSetId
The GeoMatchSetId for an GeoMatchSet. You can use GeoMatchSetId in a
GetGeoMatchSet request to get detailed information about an GeoMatchSet.
String name
A friendly name or description of the GeoMatchSet. You can't change the name of an
GeoMatchSet after you create it.
String action
Specifies whether to insert or delete a country with UpdateGeoMatchSet.
GeoMatchConstraint geoMatchConstraint
The country from which web requests originate that you want AWS WAF to search for.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is
returned by CreateByteMatchSet and by ListByteMatchSets.
ByteMatchSet byteMatchSet
Information about the ByteMatchSet that you specified in the GetByteMatchSet request. For
more information, see the following topics:
ByteMatchSet: Contains ByteMatchSetId, ByteMatchTuples, and Name
ByteMatchTuples: Contains an array of ByteMatchTuple objects. Each
ByteMatchTuple object contains FieldToMatch, PositionalConstraint,
TargetString, and TextTransformation
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used in the request. Use this value in a GetChangeTokenStatus
request to get the current status of the request.
String changeToken
The change token for which you want to get the status. This change token was previously returned in the
GetChangeToken response.
String changeTokenStatus
The status of the change token.
String geoMatchSetId
The GeoMatchSetId of the GeoMatchSet that you want to get. GeoMatchSetId is
returned by CreateGeoMatchSet and by ListGeoMatchSets.
GeoMatchSet geoMatchSet
Information about the GeoMatchSet that you specified in the GetGeoMatchSet request. This
includes the Type, which for a GeoMatchContraint is always Country, as
well as the Value, which is the identifier for a specific country.
String iPSetId
The IPSetId of the IPSet that you want to get. IPSetId is returned by
CreateIPSet and by ListIPSets.
IPSet iPSet
Information about the IPSet that you specified in the GetIPSet request. For more information,
see the following topics:
IPSet: Contains IPSetDescriptors, IPSetId, and Name
IPSetDescriptors: Contains an array of IPSetDescriptor objects. Each
IPSetDescriptor object contains Type and Value
String resourceArn
The Amazon Resource Name (ARN) of the RuleGroup for which you want to get the policy.
String policy
The IAM policy attached to the specified RuleGroup.
String ruleId
The RuleId of the RateBasedRule for which you want to get a list of ManagedKeys.
RuleId is returned by CreateRateBasedRule and by ListRateBasedRules.
String nextMarker
A null value and not currently used. Do not include this in your request.
List<E> managedKeys
An array of IP addresses that currently are blocked by the specified RateBasedRule.
String nextMarker
A null value and not currently used.
String ruleId
The RuleId of the RateBasedRule that you want to get. RuleId is returned by
CreateRateBasedRule and by ListRateBasedRules.
RateBasedRule rule
Information about the RateBasedRule that you specified in the GetRateBasedRule request.
String regexMatchSetId
The RegexMatchSetId of the RegexMatchSet that you want to get. RegexMatchSetId
is returned by CreateRegexMatchSet and by ListRegexMatchSets.
RegexMatchSet regexMatchSet
Information about the RegexMatchSet that you specified in the GetRegexMatchSet request. For
more information, see RegexMatchTuple.
String regexPatternSetId
The RegexPatternSetId of the RegexPatternSet that you want to get.
RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
RegexPatternSet regexPatternSet
Information about the RegexPatternSet that you specified in the GetRegexPatternSet request,
including the identifier of the pattern set and the regular expression patterns you want AWS WAF to search for.
String ruleGroupId
The RuleGroupId of the RuleGroup that you want to get. RuleGroupId is returned
by CreateRuleGroup and by ListRuleGroups.
String ruleId
The RuleId of the Rule that you want to get. RuleId is returned by
CreateRule and by ListRules.
Rule rule
String webAclId
The WebACLId of the WebACL for which you want GetSampledRequests to return
a sample of requests.
String ruleId
RuleId is one of three values:
The RuleId of the Rule or the RuleGroupId of the RuleGroup
for which you want GetSampledRequests to return a sample of requests.
Default_Action, which causes GetSampledRequests to return a sample of the requests that
didn't match any of the rules in the specified WebACL.
TimeWindow timeWindow
The start date and time and the end date and time of the range for which you want GetSampledRequests
to return a sample of requests. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
Long maxItems
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource
received during the time range. If your resource received fewer requests than the value of MaxItems,
GetSampledRequests returns information about all of them.
List<E> sampledRequests
A complex type that contains detailed information about each of the requests in the sample.
Long populationSize
The total number of requests from which GetSampledRequests got a sample of MaxItems
requests. If PopulationSize is less than MaxItems, the sample includes every request
that your AWS resource received during the specified time range.
TimeWindow timeWindow
Usually, TimeWindow is the time range that you specified in the GetSampledRequests
request. However, if your AWS resource received more than 5,000 requests during the time range that you specified
in the request, GetSampledRequests returns the time range for the first 5,000 requests.
String sizeConstraintSetId
The SizeConstraintSetId of the SizeConstraintSet that you want to get.
SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
SizeConstraintSet sizeConstraintSet
Information about the SizeConstraintSet that you specified in the GetSizeConstraintSet
request. For more information, see the following topics:
SizeConstraintSet: Contains SizeConstraintSetId, SizeConstraints, and
Name
SizeConstraints: Contains an array of SizeConstraint objects. Each
SizeConstraint object contains FieldToMatch, TextTransformation,
ComparisonOperator, and Size
FieldToMatch: Contains Data and Type
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get.
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
SqlInjectionMatchSet sqlInjectionMatchSet
Information about the SqlInjectionMatchSet that you specified in the GetSqlInjectionMatchSet
request. For more information, see the following topics:
SqlInjectionMatchSet: Contains Name, SqlInjectionMatchSetId, and an array of
SqlInjectionMatchTuple objects
SqlInjectionMatchTuple: Each SqlInjectionMatchTuple object contains FieldToMatch
and TextTransformation
FieldToMatch: Contains Data and Type
String resourceArn
The ARN (Amazon Resource Name) of the resource for which to get the web ACL.
WebACLSummary webACLSummary
Information about the web ACL that you specified in the GetWebACLForResource request. If there is no
associated resource, a null WebACLSummary is returned.
String webACLId
The WebACLId of the WebACL that you want to get. WebACLId is returned by
CreateWebACL and by ListWebACLs.
String xssMatchSetId
The XssMatchSetId of the XssMatchSet that you want to get. XssMatchSetId is
returned by CreateXssMatchSet and by ListXssMatchSets.
XssMatchSet xssMatchSet
Information about the XssMatchSet that you specified in the GetXssMatchSet request. For more
information, see the following topics:
XssMatchSet: Contains Name, XssMatchSetId, and an array of
XssMatchTuple objects
XssMatchTuple: Each XssMatchTuple object contains FieldToMatch and
TextTransformation
FieldToMatch: Contains Data and Type
String clientIP
The IP address that the request originated from. If the WebACL is associated with a CloudFront
distribution, this is the value of one of the following fields in CloudFront access logs:
c-ip, if the viewer did not use an HTTP proxy or a load balancer to send the request
x-forwarded-for, if the viewer did use an HTTP proxy or a load balancer to send the request
String country
The two-letter country code for the country that the request originated from. For a current list of country codes, see the Wikipedia entry ISO 3166-1 alpha-2.
String uRI
The part of a web request that identifies the resource, for example, /images/daily-ad.jpg.
String method
The HTTP method specified in the sampled web request. CloudFront supports the following methods:
DELETE, GET, HEAD, OPTIONS, PATCH,
POST, and PUT.
String hTTPVersion
The HTTP version specified in the sampled web request, for example, HTTP/1.1.
List<E> headers
A complex type that contains two values for each header in the sampled web request: the name of the header and the value of the header.
String iPSetId
The IPSetId for an IPSet. You use IPSetId to get information about an
IPSet (see GetIPSet), update an IPSet (see UpdateIPSet), insert an
IPSet into a Rule or delete one from a Rule (see UpdateRule), and
delete an IPSet from AWS WAF (see DeleteIPSet).
IPSetId is returned by CreateIPSet and by ListIPSets.
String name
A friendly name or description of the IPSet. You can't change the name of an IPSet after you
create it.
List<E> iPSetDescriptors
The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
requests originate from. If the WebACL is associated with a CloudFront distribution and the viewer
did not use an HTTP proxy or a load balancer to send the request, this is the value of the c-ip field in the
CloudFront access logs.
String type
Specify IPV4 or IPV6.
String value
Specify an IPv4 address by using CIDR notation. For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
192.0.2.255, specify 192.0.2.0/24.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Specify an IPv6 address by using CIDR notation. For example:
To configure AWS WAF to allow, block, or count requests that originated from the IP address
1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses
1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
String action
Specifies whether to insert or delete an IP address with UpdateIPSet.
IPSetDescriptor iPSetDescriptor
The IP address type (IPV4 or IPV6) and the IP address range (in CIDR notation) that web
requests originate from.
String ruleGroupId
The RuleGroupId of the RuleGroup for which you want to get a list of ActivatedRule
objects.
String nextMarker
If you specify a value for Limit and you have more ActivatedRules than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of ActivatedRules. For the second and subsequent
ListActivatedRulesInRuleGroup requests, specify the value of NextMarker from the
previous response to get information about another batch of ActivatedRules.
Integer limit
Specifies the number of ActivatedRules that you want AWS WAF to return for this request. If you have
more ActivatedRules than the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of ActivatedRules.
String nextMarker
If you have more ActivatedRules than the number that you specified for Limit in the
request, the response includes a NextMarker value. To list more ActivatedRules, submit
another ListActivatedRulesInRuleGroup request, and specify the NextMarker value from
the response in the NextMarker value in the next request.
List<E> activatedRules
An array of ActivatedRules objects.
String nextMarker
If you specify a value for Limit and you have more ByteMatchSets than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of ByteMatchSets. For the second and subsequent ListByteMatchSets
requests, specify the value of NextMarker from the previous response to get information about
another batch of ByteMatchSets.
Integer limit
Specifies the number of ByteMatchSet objects that you want AWS WAF to return for this request. If
you have more ByteMatchSets objects than the number you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of ByteMatchSet
objects.
String nextMarker
If you have more ByteMatchSet objects than the number that you specified for Limit in
the request, the response includes a NextMarker value. To list more ByteMatchSet
objects, submit another ListByteMatchSets request, and specify the NextMarker value
from the response in the NextMarker value in the next request.
List<E> byteMatchSets
An array of ByteMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more GeoMatchSets than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of GeoMatchSet objects. For the second and subsequent ListGeoMatchSets
requests, specify the value of NextMarker from the previous response to get information about
another batch of GeoMatchSet objects.
Integer limit
Specifies the number of GeoMatchSet objects that you want AWS WAF to return for this request. If you
have more GeoMatchSet objects than the number you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of GeoMatchSet
objects.
String nextMarker
If you have more GeoMatchSet objects than the number that you specified for Limit in
the request, the response includes a NextMarker value. To list more GeoMatchSet
objects, submit another ListGeoMatchSets request, and specify the NextMarker value from
the response in the NextMarker value in the next request.
List<E> geoMatchSets
An array of GeoMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more IPSets than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of IPSets. For the second and subsequent ListIPSets requests, specify the
value of NextMarker from the previous response to get information about another batch of
IPSets.
Integer limit
Specifies the number of IPSet objects that you want AWS WAF to return for this request. If you have
more IPSet objects than the number you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of IPSet objects.
String nextMarker
If you have more IPSet objects than the number that you specified for Limit in the
request, the response includes a NextMarker value. To list more IPSet objects, submit
another ListIPSets request, and specify the NextMarker value from the response in the
NextMarker value in the next request.
List<E> iPSets
An array of IPSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more Rules than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRateBasedRules requests,
specify the value of NextMarker from the previous response to get information about another batch of
Rules.
Integer limit
Specifies the number of Rules that you want AWS WAF to return for this request. If you have more
Rules than the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of Rules.
String nextMarker
If you have more Rules than the number that you specified for Limit in the request, the
response includes a NextMarker value. To list more Rules, submit another
ListRateBasedRules request, and specify the NextMarker value from the response in the
NextMarker value in the next request.
List<E> rules
An array of RuleSummary objects.
String nextMarker
If you specify a value for Limit and you have more RegexMatchSet objects than the value
of Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of ByteMatchSets. For the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker from the previous response to get information about
another batch of RegexMatchSet objects.
Integer limit
Specifies the number of RegexMatchSet objects that you want AWS WAF to return for this request. If
you have more RegexMatchSet objects than the number you specify for Limit, the response
includes a NextMarker value that you can use to get another batch of RegexMatchSet
objects.
String nextMarker
If you have more RegexMatchSet objects than the number that you specified for Limit in
the request, the response includes a NextMarker value. To list more RegexMatchSet
objects, submit another ListRegexMatchSets request, and specify the NextMarker value
from the response in the NextMarker value in the next request.
List<E> regexMatchSets
An array of RegexMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more RegexPatternSet objects than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to
list another group of RegexPatternSet objects. For the second and subsequent
ListRegexPatternSets requests, specify the value of NextMarker from the previous
response to get information about another batch of RegexPatternSet objects.
Integer limit
Specifies the number of RegexPatternSet objects that you want AWS WAF to return for this request. If
you have more RegexPatternSet objects than the number you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of
RegexPatternSet objects.
String nextMarker
If you have more RegexPatternSet objects than the number that you specified for Limit
in the request, the response includes a NextMarker value. To list more RegexPatternSet
objects, submit another ListRegexPatternSets request, and specify the NextMarker value
from the response in the NextMarker value in the next request.
List<E> regexPatternSets
An array of RegexPatternSetSummary objects.
String webACLId
The unique identifier (ID) of the web ACL for which to list the associated resources.
String nextMarker
If you specify a value for Limit and you have more RuleGroups than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of RuleGroups. For the second and subsequent ListRuleGroups requests,
specify the value of NextMarker from the previous response to get information about another batch of
RuleGroups.
Integer limit
Specifies the number of RuleGroups that you want AWS WAF to return for this request. If you have
more RuleGroups than the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of RuleGroups.
String nextMarker
If you have more RuleGroups than the number that you specified for Limit in the
request, the response includes a NextMarker value. To list more RuleGroups, submit
another ListRuleGroups request, and specify the NextMarker value from the response in
the NextMarker value in the next request.
List<E> ruleGroups
An array of RuleGroup objects.
String nextMarker
If you specify a value for Limit and you have more Rules than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of Rules. For the second and subsequent ListRules requests, specify the
value of NextMarker from the previous response to get information about another batch of
Rules.
Integer limit
Specifies the number of Rules that you want AWS WAF to return for this request. If you have more
Rules than the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of Rules.
String nextMarker
If you have more Rules than the number that you specified for Limit in the request, the
response includes a NextMarker value. To list more Rules, submit another
ListRules request, and specify the NextMarker value from the response in the
NextMarker value in the next request.
List<E> rules
An array of RuleSummary objects.
String nextMarker
If you specify a value for Limit and you have more SizeConstraintSets than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of SizeConstraintSets. For the second and subsequent
ListSizeConstraintSets requests, specify the value of NextMarker from the previous
response to get information about another batch of SizeConstraintSets.
Integer limit
Specifies the number of SizeConstraintSet objects that you want AWS WAF to return for this request.
If you have more SizeConstraintSets objects than the number you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of
SizeConstraintSet objects.
String nextMarker
If you have more SizeConstraintSet objects than the number that you specified for Limit
in the request, the response includes a NextMarker value. To list more
SizeConstraintSet objects, submit another ListSizeConstraintSets request, and specify
the NextMarker value from the response in the NextMarker value in the next request.
List<E> sizeConstraintSets
An array of SizeConstraintSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more SqlInjectionMatchSet objects than the
value of Limit, AWS WAF returns a NextMarker value in the response that allows you to
list another group of SqlInjectionMatchSets. For the second and subsequent
ListSqlInjectionMatchSets requests, specify the value of NextMarker from the previous
response to get information about another batch of SqlInjectionMatchSets.
Integer limit
Specifies the number of SqlInjectionMatchSet objects that you want AWS WAF to return for this request. If
you have more SqlInjectionMatchSet objects than the number you specify for Limit, the
response includes a NextMarker value that you can use to get another batch of Rules.
String nextMarker
If you have more SqlInjectionMatchSet objects than the number that you specified for Limit in
the request, the response includes a NextMarker value. To list more
SqlInjectionMatchSet objects, submit another ListSqlInjectionMatchSets request, and
specify the NextMarker value from the response in the NextMarker value in the next
request.
List<E> sqlInjectionMatchSets
An array of SqlInjectionMatchSetSummary objects.
String nextMarker
If you specify a value for Limit and you have more ByteMatchSetssubscribed rule groups
than the value of Limit, AWS WAF returns a NextMarker value in the response that allows
you to list another group of subscribed rule groups. For the second and subsequent
ListSubscribedRuleGroupsRequest requests, specify the value of NextMarker from the
previous response to get information about another batch of subscribed rule groups.
Integer limit
Specifies the number of subscribed rule groups that you want AWS WAF to return for this request. If you have more
objects than the number you specify for Limit, the response includes a NextMarker value
that you can use to get another batch of objects.
String nextMarker
If you have more objects than the number that you specified for Limit in the request, the response
includes a NextMarker value. To list more objects, submit another
ListSubscribedRuleGroups request, and specify the NextMarker value from the response in
the NextMarker value in the next request.
List<E> ruleGroups
An array of RuleGroup objects.
String nextMarker
If you specify a value for Limit and you have more WebACL objects than the number that
you specify for Limit, AWS WAF returns a NextMarker value in the response that allows
you to list another group of WebACL objects. For the second and subsequent ListWebACLs
requests, specify the value of NextMarker from the previous response to get information about
another batch of WebACL objects.
Integer limit
Specifies the number of WebACL objects that you want AWS WAF to return for this request. If you have
more WebACL objects than the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of WebACL objects.
String nextMarker
If you have more WebACL objects than the number that you specified for Limit in the
request, the response includes a NextMarker value. To list more WebACL objects, submit
another ListWebACLs request, and specify the NextMarker value from the response in the
NextMarker value in the next request.
List<E> webACLs
An array of WebACLSummary objects.
String nextMarker
If you specify a value for Limit and you have more XssMatchSet objects than the value of
Limit, AWS WAF returns a NextMarker value in the response that allows you to list
another group of XssMatchSets. For the second and subsequent ListXssMatchSets requests,
specify the value of NextMarker from the previous response to get information about another batch of
XssMatchSets.
Integer limit
Specifies the number of XssMatchSet objects that you want AWS WAF to return for this request. If you have
more XssMatchSet objects than the number you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of Rules.
String nextMarker
If you have more XssMatchSet objects than the number that you specified for Limit in the
request, the response includes a NextMarker value. To list more XssMatchSet objects,
submit another ListXssMatchSets request, and specify the NextMarker value from the
response in the NextMarker value in the next request.
List<E> xssMatchSets
An array of XssMatchSetSummary objects.
Boolean negated
Set Negated to False if you want AWS WAF to allow, block, or count requests based on
the settings in the specified ByteMatchSet, IPSet, SqlInjectionMatchSet, XssMatchSet,
RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an IPSet
includes the IP address 192.0.2.44, AWS WAF will allow or block requests based on that IP address.
Set Negated to True if you want AWS WAF to allow or block a request based on the
negation of the settings in the ByteMatchSet, IPSet, SqlInjectionMatchSet,
XssMatchSet, RegexMatchSet, GeoMatchSet, or SizeConstraintSet. For example, if an
IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests
based on all IP addresses except 192.0.2.44.
String type
The type of predicate in a Rule, such as ByteMatchSet or IPSet.
String dataId
A unique identifier for a predicate in a Rule, such as ByteMatchSetId or
IPSetId. The ID is returned by the corresponding Create or List command.
String ruleId
A unique identifier for a RateBasedRule. You use RuleId to get more information about a
RateBasedRule (see GetRateBasedRule), update a RateBasedRule (see
UpdateRateBasedRule), insert a RateBasedRule into a WebACL or delete one from a
WebACL (see UpdateWebACL), or delete a RateBasedRule from AWS WAF (see
DeleteRateBasedRule).
String name
A friendly name or description for a RateBasedRule. You can't change the name of a
RateBasedRule after you create it.
String metricName
A friendly name or description for the metrics for a RateBasedRule. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the
metric after you create the RateBasedRule.
List<E> matchPredicates
The Predicates object contains one Predicate element for each ByteMatchSet,
IPSet, or SqlInjectionMatchSet object that you want to include in a RateBasedRule.
String rateKey
The field that AWS WAF uses to determine if requests are likely arriving from single source and thus subject to
rate monitoring. The only valid value for RateKey is IP. IP indicates that
requests arriving from the same IP address are subject to the RateLimit that is specified in the
RateBasedRule.
Long rateLimit
The maximum number of requests, which have an identical value in the field specified by the RateKey,
allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other
predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
String regexMatchSetId
The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
information about a RegexMatchSet (see GetRegexMatchSet), update a RegexMatchSet
(see UpdateRegexMatchSet), insert a RegexMatchSet into a Rule or delete one from
a Rule (see UpdateRule), and delete a RegexMatchSet from AWS WAF (see
DeleteRegexMatchSet).
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
String name
A friendly name or description of the RegexMatchSet. You can't change Name after you create a
RegexMatchSet.
List<E> regexMatchTuples
Contains an array of RegexMatchTuple objects. Each RegexMatchTuple object contains:
The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the
User-Agent header.
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
String regexMatchSetId
The RegexMatchSetId for a RegexMatchSet. You use RegexMatchSetId to get
information about a RegexMatchSet, update a RegexMatchSet, remove a
RegexMatchSet from a Rule, and delete a RegexMatchSet from AWS WAF.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
String name
A friendly name or description of the RegexMatchSet. You can't change Name after you create a
RegexMatchSet.
String action
Specifies whether to insert or delete a RegexMatchTuple.
RegexMatchTuple regexMatchTuple
Information about the part of a web request that you want AWS WAF to inspect and the identifier of the regular
expression (regex) pattern that you want AWS WAF to search for. If you specify DELETE for the value
of Action, the RegexMatchTuple values must exactly match the values in the
RegexMatchTuple that you want to delete from the RegexMatchSet.
FieldToMatch fieldToMatch
Specifies where in a web request to look for the RegexPatternSet.
String textTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on
RegexPatternSet before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
String regexPatternSetId
The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to
get information about a RegexPatternSet (see GetRegexPatternSet), update a
RegexPatternSet (see UpdateRegexPatternSet), insert a RegexPatternSet into a
RegexMatchSet or delete one from a RegexMatchSet (see UpdateRegexMatchSet), and
delete an RegexPatternSet from AWS WAF (see DeleteRegexPatternSet).
RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
String regexPatternSetId
The identifier for the RegexPatternSet. You use RegexPatternSetId to get information
about a RegexPatternSet, update a RegexPatternSet, remove a
RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
AWS WAF.
RegexMatchSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
String name
A friendly name or description of the RegexPatternSet. You can't change Name after you create
a RegexPatternSet.
List<E> regexPatternStrings
Specifies the regular expression (regex) patterns that you want AWS WAF to search for, such as
B[a@]dB[o0]t.
String regexPatternSetId
The RegexPatternSetId for a RegexPatternSet. You use RegexPatternSetId to
get information about a RegexPatternSet, update a RegexPatternSet, remove a
RegexPatternSet from a RegexMatchSet, and delete a RegexPatternSet from
AWS WAF.
RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
String name
A friendly name or description of the RegexPatternSet. You can't change Name after you create
a RegexPatternSet.
String ruleId
A unique identifier for a Rule. You use RuleId to get more information about a
Rule (see GetRule), update a Rule (see UpdateRule), insert a
Rule into a WebACL or delete a one from a WebACL (see
UpdateWebACL), or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
String name
The friendly name or description for the Rule. You can't change the name of a Rule
after you create it.
String metricName
A friendly name or description for the metrics for this Rule. The name can contain only alphanumeric
characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change MetricName after you
create the Rule.
List<E> predicates
The Predicates object contains one Predicate element for each ByteMatchSet,
IPSet, or SqlInjectionMatchSet object that you want to include in a Rule.
String ruleGroupId
A unique identifier for a RuleGroup. You use RuleGroupId to get more information about
a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup),
insert a RuleGroup into a WebACL or delete a one from a WebACL (see
UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
String name
The friendly name or description for the RuleGroup. You can't change the name of a
RuleGroup after you create it.
String metricName
A friendly name or description for the metrics for this RuleGroup. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the
metric after you create the RuleGroup.
String ruleGroupId
A unique identifier for a RuleGroup. You use RuleGroupId to get more information about
a RuleGroup (see GetRuleGroup), update a RuleGroup (see UpdateRuleGroup),
insert a RuleGroup into a WebACL or delete one from a WebACL (see
UpdateWebACL), or delete a RuleGroup from AWS WAF (see DeleteRuleGroup).
RuleGroupId is returned by CreateRuleGroup and by ListRuleGroups.
String name
A friendly name or description of the RuleGroup. You can't change the name of a RuleGroup
after you create it.
String action
Specify INSERT to add an ActivatedRule to a RuleGroup. Use
DELETE to remove an ActivatedRule from a RuleGroup.
ActivatedRule activatedRule
The ActivatedRule object specifies a Rule that you want to insert or delete, the
priority of the Rule in the WebACL, and the action that you want AWS WAF to take when a
web request matches the Rule (ALLOW, BLOCK, or COUNT).
String ruleId
A unique identifier for a Rule. You use RuleId to get more information about a
Rule (see GetRule), update a Rule (see UpdateRule), insert a
Rule into a WebACL or delete one from a WebACL (see UpdateWebACL),
or delete a Rule from AWS WAF (see DeleteRule).
RuleId is returned by CreateRule and by ListRules.
String name
A friendly name or description of the Rule. You can't change the name of a Rule after you
create it.
HTTPRequest request
A complex type that contains detailed information about the request.
Long weight
A value that indicates how one result in the response relates proportionally to other results in the response. A
result that has a weight of 2 represents roughly twice as many CloudFront web requests as a result
that has a weight of 1.
Date timestamp
The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
String action
The action for the Rule that the request matched: ALLOW, BLOCK, or
COUNT.
String ruleWithinRuleGroup
This value is returned if the GetSampledRequests request specifies the ID of a
RuleGroup rather than the ID of an individual rule. RuleWithinRuleGroup is the rule
within the specified RuleGroup that matched the request listed in the response.
FieldToMatch fieldToMatch
Specifies where in a web request to look for the size constraint.
String textTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting a request for a match.
Note that if you choose BODY for the value of Type, you must choose NONE
for TextTransformation because CloudFront forwards only the first 8192 bytes for inspection.
NONE
Specify NONE if you don't want to perform any text transformations.
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
String comparisonOperator
The type of comparison you want AWS WAF to perform. AWS WAF uses this in combination with the provided
Size and FieldToMatch to build an expression in the form of "Size
ComparisonOperator size in bytes of FieldToMatch". If that expression is true, the
SizeConstraint is considered to match.
EQ: Used to test if the Size is equal to the size of the FieldToMatch
NE: Used to test if the Size is not equal to the size of the FieldToMatch
LE: Used to test if the Size is less than or equal to the size of the
FieldToMatch
LT: Used to test if the Size is strictly less than the size of the FieldToMatch
GE: Used to test if the Size is greater than or equal to the size of the
FieldToMatch
GT: Used to test if the Size is strictly greater than the size of the
FieldToMatch
Long size
The size in bytes that you want AWS WAF to compare against the size of the specified FieldToMatch.
AWS WAF uses this in combination with ComparisonOperator and FieldToMatch to build an
expression in the form of "Size ComparisonOperator size in bytes of
FieldToMatch". If that expression is true, the SizeConstraint is considered to match.
Valid values for size are 0 - 21474836480 bytes (0 - 20 GB).
If you specify URI for the value of Type, the / in the URI counts as one character. For
example, the URI /logo.jpg is nine characters long.
String sizeConstraintSetId
A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
information about a SizeConstraintSet (see GetSizeConstraintSet), update a
SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
a Rule or delete one from a Rule (see UpdateRule), and delete a
SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
String name
The name, if any, of the SizeConstraintSet.
List<E> sizeConstraints
Specifies the parts of web requests that you want to inspect the size of.
String sizeConstraintSetId
A unique identifier for a SizeConstraintSet. You use SizeConstraintSetId to get
information about a SizeConstraintSet (see GetSizeConstraintSet), update a
SizeConstraintSet (see UpdateSizeConstraintSet), insert a SizeConstraintSet into
a Rule or delete one from a Rule (see UpdateRule), and delete a
SizeConstraintSet from AWS WAF (see DeleteSizeConstraintSet).
SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
String name
The name of the SizeConstraintSet, if any.
String action
Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use
DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.
SizeConstraint sizeConstraint
Specifies a constraint on the size of a part of the web request. AWS WAF uses the Size,
ComparisonOperator, and FieldToMatch to build an expression in the form of "
Size ComparisonOperator size in bytes of FieldToMatch". If that expression
is true, the SizeConstraint is considered to match.
String sqlInjectionMatchSetId
A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get
information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a
SqlInjectionMatchSet into a Rule or delete one from a Rule (see
UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see
DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String name
The name, if any, of the SqlInjectionMatchSet.
List<E> sqlInjectionMatchTuples
Specifies the parts of web requests that you want to inspect for snippets of malicious SQL code.
String sqlInjectionMatchSetId
A unique identifier for a SqlInjectionMatchSet. You use SqlInjectionMatchSetId to get
information about a SqlInjectionMatchSet (see GetSqlInjectionMatchSet), update a
SqlInjectionMatchSet (see UpdateSqlInjectionMatchSet), insert a
SqlInjectionMatchSet into a Rule or delete one from a Rule (see
UpdateRule), and delete a SqlInjectionMatchSet from AWS WAF (see
DeleteSqlInjectionMatchSet).
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String name
The name of the SqlInjectionMatchSet, if any, specified by Id.
String action
Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use
DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.
SqlInjectionMatchTuple sqlInjectionMatchTuple
Specifies the part of a web request that you want AWS WAF to inspect for snippets of malicious SQL code and, if you want AWS WAF to inspect a header, the name of the header.
FieldToMatch fieldToMatch
Specifies where in a web request to look for snippets of malicious SQL code.
String textTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
String ruleGroupId
A unique identifier for a RuleGroup.
String name
A friendly name or description of the RuleGroup. You can't change the name of a
RuleGroup after you create it.
String metricName
A friendly name or description for the metrics for this RuleGroup. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change the name of the
metric after you create the RuleGroup.
Date startTime
The beginning of the time range from which you want GetSampledRequests to return a sample of the
requests that your AWS resource received. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
Date endTime
The end of the time range from which you want GetSampledRequests to return a sample of the requests
that your AWS resource received. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
String byteMatchSetId
The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId
is returned by CreateByteMatchSet and by ListByteMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of ByteMatchSetUpdate objects that you want to insert into or delete from a
ByteMatchSet. For more information, see the applicable data types:
ByteMatchSetUpdate: Contains Action and ByteMatchTuple
ByteMatchTuple: Contains FieldToMatch, PositionalConstraint,
TargetString, and TextTransformation
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used to submit the UpdateByteMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String geoMatchSetId
The GeoMatchSetId of the GeoMatchSet that you want to update. GeoMatchSetId is
returned by CreateGeoMatchSet and by ListGeoMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of GeoMatchSetUpdate objects that you want to insert into or delete from an
GeoMatchSet. For more information, see the applicable data types:
GeoMatchSetUpdate: Contains Action and GeoMatchConstraint
GeoMatchConstraint: Contains Type and Value
You can have only one Type and Value per GeoMatchConstraint. To add
multiple countries, include multiple GeoMatchSetUpdate objects in your request.
String changeToken
The ChangeToken that you used to submit the UpdateGeoMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String iPSetId
The IPSetId of the IPSet that you want to update. IPSetId is returned by
CreateIPSet and by ListIPSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of IPSetUpdate objects that you want to insert into or delete from an IPSet. For
more information, see the applicable data types:
IPSetUpdate: Contains Action and IPSetDescriptor
IPSetDescriptor: Contains Type and Value
String changeToken
The ChangeToken that you used to submit the UpdateIPSet request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String ruleId
The RuleId of the RateBasedRule that you want to update. RuleId is
returned by CreateRateBasedRule and by ListRateBasedRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of RuleUpdate objects that you want to insert into or delete from a RateBasedRule.
Long rateLimit
The maximum number of requests, which have an identical value in the field specified by the RateKey,
allowed in a five-minute period. If the number of requests exceeds the RateLimit and the other
predicates specified in the rule are also met, AWS WAF triggers the action that is specified for this rule.
String changeToken
The ChangeToken that you used to submit the UpdateRateBasedRule request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String regexMatchSetId
The RegexMatchSetId of the RegexMatchSet that you want to update.
RegexMatchSetId is returned by CreateRegexMatchSet and by ListRegexMatchSets.
List<E> updates
An array of RegexMatchSetUpdate objects that you want to insert into or delete from a
RegexMatchSet. For more information, see RegexMatchTuple.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the UpdateRegexMatchSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String regexPatternSetId
The RegexPatternSetId of the RegexPatternSet that you want to update.
RegexPatternSetId is returned by CreateRegexPatternSet and by ListRegexPatternSets.
List<E> updates
An array of RegexPatternSetUpdate objects that you want to insert into or delete from a
RegexPatternSet.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the UpdateRegexPatternSet request. You can also
use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String ruleGroupId
The RuleGroupId of the RuleGroup that you want to update. RuleGroupId is
returned by CreateRuleGroup and by ListRuleGroups.
List<E> updates
An array of RuleGroupUpdate objects that you want to insert into or delete from a RuleGroup.
You can only insert REGULAR rules into a rule group.
ActivatedRule|OverrideAction applies only when updating or adding a RuleGroup to a
WebACL. In this case you do not use ActivatedRule|Action. For all other update
requests, ActivatedRule|Action is used instead of ActivatedRule|OverrideAction.
String changeToken
The value returned by the most recent call to GetChangeToken.
String changeToken
The ChangeToken that you used to submit the UpdateRuleGroup request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String ruleId
The RuleId of the Rule that you want to update. RuleId is returned by
CreateRule and by ListRules.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of RuleUpdate objects that you want to insert into or delete from a Rule. For more
information, see the applicable data types:
RuleUpdate: Contains Action and Predicate
Predicate: Contains DataId, Negated, and Type
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used to submit the UpdateRule request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String sizeConstraintSetId
The SizeConstraintSetId of the SizeConstraintSet that you want to update.
SizeConstraintSetId is returned by CreateSizeConstraintSet and by
ListSizeConstraintSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of SizeConstraintSetUpdate objects that you want to insert into or delete from a
SizeConstraintSet. For more information, see the applicable data types:
SizeConstraintSetUpdate: Contains Action and SizeConstraint
SizeConstraint: Contains FieldToMatch, TextTransformation,
ComparisonOperator, and Size
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used to submit the UpdateSizeConstraintSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String sqlInjectionMatchSetId
The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update.
SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by
ListSqlInjectionMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of SqlInjectionMatchSetUpdate objects that you want to insert into or delete from a
SqlInjectionMatchSet. For more information, see the applicable data types:
SqlInjectionMatchSetUpdate: Contains Action and SqlInjectionMatchTuple
SqlInjectionMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used to submit the UpdateSqlInjectionMatchSet request. You can
also use this value to query the status of the request. For more information, see GetChangeTokenStatus.
String webACLId
The WebACLId of the WebACL that you want to update. WebACLId is returned by
CreateWebACL and by ListWebACLs.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of updates to make to the WebACL.
An array of WebACLUpdate objects that you want to insert into or delete from a WebACL. For
more information, see the applicable data types:
WebACLUpdate: Contains Action and ActivatedRule
ActivatedRule: Contains Action, OverrideAction, Priority,
RuleId, and Type. ActivatedRule|OverrideAction applies only when updating
or adding a RuleGroup to a WebACL. In this case you do not use
ActivatedRule|Action. For all other update requests, ActivatedRule|Action is used
instead of ActivatedRule|OverrideAction.
WafAction: Contains Type
WafAction defaultAction
A default action for the web ACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the rules in a web ACL.
String changeToken
The ChangeToken that you used to submit the UpdateWebACL request. You can also use this
value to query the status of the request. For more information, see GetChangeTokenStatus.
String xssMatchSetId
The XssMatchSetId of the XssMatchSet that you want to update.
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
String changeToken
The value returned by the most recent call to GetChangeToken.
List<E> updates
An array of XssMatchSetUpdate objects that you want to insert into or delete from a
XssMatchSet. For more information, see the applicable data types:
XssMatchSetUpdate: Contains Action and XssMatchTuple
XssMatchTuple: Contains FieldToMatch and TextTransformation
FieldToMatch: Contains Data and Type
String changeToken
The ChangeToken that you used to submit the UpdateXssMatchSet request. You can also use
this value to query the status of the request. For more information, see GetChangeTokenStatus.
String type
Specifies how you want AWS WAF to respond to requests that match the settings in a Rule. Valid
settings include the following:
ALLOW: AWS WAF allows requests
BLOCK: AWS WAF blocks requests
COUNT: AWS WAF increments a counter of the requests that match all of the conditions in the rule.
AWS WAF then continues to inspect the web request based on the remaining rules in the web ACL. You can't specify
COUNT for the default action for a WebACL.
String type
COUNT overrides the action specified by the individual rule within a RuleGroup . If set
to NONE, the rule's action will take place.
String webACLId
A unique identifier for a WebACL. You use WebACLId to get information about a
WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a
WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by ListWebACLs.
String name
A friendly name or description of the WebACL. You can't change the name of a WebACL
after you create it.
String metricName
A friendly name or description for the metrics for this WebACL. The name can contain only
alphanumeric characters (A-Z, a-z, 0-9); the name can't contain whitespace. You can't change
MetricName after you create the WebACL.
WafAction defaultAction
The action to perform if none of the Rules contained in the WebACL match. The action is
specified by the WafAction object.
List<E> rules
An array that contains the action for each Rule in a WebACL, the priority of the
Rule, and the ID of the Rule.
String webACLId
A unique identifier for a WebACL. You use WebACLId to get information about a
WebACL (see GetWebACL), update a WebACL (see UpdateWebACL), and delete a
WebACL from AWS WAF (see DeleteWebACL).
WebACLId is returned by CreateWebACL and by ListWebACLs.
String name
A friendly name or description of the WebACL. You can't change the name of a WebACL after you
create it.
String action
Specifies whether to insert a Rule into or delete a Rule from a WebACL.
ActivatedRule activatedRule
The ActivatedRule object in an UpdateWebACL request specifies a Rule that you
want to insert or delete, the priority of the Rule in the WebACL, and the action that
you want AWS WAF to take when a web request matches the Rule (ALLOW, BLOCK
, or COUNT).
String xssMatchSetId
A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
an XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
DeleteXssMatchSet).
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
String name
The name, if any, of the XssMatchSet.
List<E> xssMatchTuples
Specifies the parts of web requests that you want to inspect for cross-site scripting attacks.
String xssMatchSetId
A unique identifier for an XssMatchSet. You use XssMatchSetId to get information about
a XssMatchSet (see GetXssMatchSet), update an XssMatchSet (see
UpdateXssMatchSet), insert an XssMatchSet into a Rule or delete one from a
Rule (see UpdateRule), and delete an XssMatchSet from AWS WAF (see
DeleteXssMatchSet).
XssMatchSetId is returned by CreateXssMatchSet and by ListXssMatchSets.
String name
The name of the XssMatchSet, if any, specified by Id.
String action
Specify INSERT to add a XssMatchSetUpdate to an XssMatchSet. Use DELETE
to remove a XssMatchSetUpdate from an XssMatchSet.
XssMatchTuple xssMatchTuple
Specifies the part of a web request that you want AWS WAF to inspect for cross-site scripting attacks and, if you want AWS WAF to inspect a header, the name of the header.
FieldToMatch fieldToMatch
Specifies where in a web request to look for cross-site scripting attacks.
String textTransformation
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass AWS WAF. If you specify a transformation, AWS WAF performs the transformation on FieldToMatch
before inspecting a request for a match.
CMD_LINE
When you're concerned that attackers are injecting an operating system commandline command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want to perform any text transformations.
Copyright © 2018. All rights reserved.