Serialized Form

Package com.amazonaws.services.waf.model

Class com.amazonaws.services.waf.model.ActivatedRule extends Object implements Serializable

Serialized Fields

priority

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.

ruleId

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.

action

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.

Class com.amazonaws.services.waf.model.ByteMatchSet extends Object implements Serializable

Serialized Fields

byteMatchSetId

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.

name

String name

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

byteMatchTuples

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.

Class com.amazonaws.services.waf.model.ByteMatchSetSummary extends Object implements Serializable

Serialized Fields

byteMatchSetId

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.

name

String name

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

Class com.amazonaws.services.waf.model.ByteMatchSetUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specifies whether to insert or delete a ByteMatchTuple.

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.

Class com.amazonaws.services.waf.model.ByteMatchTuple extends Object implements Serializable

Serialized Fields

fieldToMatch

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.

targetString

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.

textTransformation

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.

positionalConstraint

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.

Class com.amazonaws.services.waf.model.CreateByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateByteMatchSetResult extends Object implements Serializable

Serialized Fields

byteMatchSet

ByteMatchSet byteMatchSet

A ByteMatchSet that contains no ByteMatchTuple objects.

changeToken

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.

Class com.amazonaws.services.waf.model.CreateIPSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateIPSetResult extends Object implements Serializable

Serialized Fields

iPSet

IPSet iPSet

The IPSet returned in the CreateIPSet response.

changeToken

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.

Class com.amazonaws.services.waf.model.CreateRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

metricName

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.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateRuleResult extends Object implements Serializable

Serialized Fields

rule

Rule rule

The Rule returned in the CreateRule response.

changeToken

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.

Class com.amazonaws.services.waf.model.CreateSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateSizeConstraintSetResult extends Object implements Serializable

Serialized Fields

sizeConstraintSet

SizeConstraintSet sizeConstraintSet

A SizeConstraintSet that contains no SizeConstraint objects.

changeToken

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.

Class com.amazonaws.services.waf.model.CreateSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateSqlInjectionMatchSetResult extends Object implements Serializable

Serialized Fields

sqlInjectionMatchSet

SqlInjectionMatchSet sqlInjectionMatchSet

A SqlInjectionMatchSet.

changeToken

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.

Class com.amazonaws.services.waf.model.CreateWebACLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

name

String name

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

metricName

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.

defaultAction

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.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.CreateWebACLResult extends Object implements Serializable

Serialized Fields

webACL

WebACL webACL

The WebACL returned in the CreateWebACL response.

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

byteMatchSetId

String byteMatchSetId

The ByteMatchSetId of the ByteMatchSet that you want to delete. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteByteMatchSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteIPSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iPSetId

String iPSetId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteIPSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleId

String ruleId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteRuleResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sizeConstraintSetId

String sizeConstraintSetId

The SizeConstraintSetId of the SizeConstraintSet that you want to delete. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteSizeConstraintSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sqlInjectionMatchSetId

String sqlInjectionMatchSetId

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to delete. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteSqlInjectionMatchSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.DeleteWebACLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

webACLId

String webACLId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

Class com.amazonaws.services.waf.model.DeleteWebACLResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.FieldToMatch extends Object implements Serializable

Serialized Fields

type

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.

data

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.

Class com.amazonaws.services.waf.model.GetByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

byteMatchSetId

String byteMatchSetId

The ByteMatchSetId of the ByteMatchSet that you want to get. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

Class com.amazonaws.services.waf.model.GetByteMatchSetResult extends Object implements Serializable

Serialized Fields

byteMatchSet

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

Class com.amazonaws.services.waf.model.GetChangeTokenRequest extends AmazonWebServiceRequest implements Serializable

Class com.amazonaws.services.waf.model.GetChangeTokenResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.GetChangeTokenStatusRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

changeToken

String changeToken

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

Class com.amazonaws.services.waf.model.GetChangeTokenStatusResult extends Object implements Serializable

Serialized Fields

changeTokenStatus

String changeTokenStatus

The status of the change token.

Class com.amazonaws.services.waf.model.GetIPSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iPSetId

String iPSetId

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

Class com.amazonaws.services.waf.model.GetIPSetResult extends Object implements Serializable

Serialized Fields

iPSet

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

Class com.amazonaws.services.waf.model.GetRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleId

String ruleId

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

Class com.amazonaws.services.waf.model.GetRuleResult extends Object implements Serializable

Serialized Fields

rule

Rule rule

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

• Rule: Contains MetricName, Name, an array of Predicate objects, and RuleId
• Predicate: Each Predicate object contains DataId, Negated, and Type

Class com.amazonaws.services.waf.model.GetSampledRequestsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

webAclId

String webAclId

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

ruleId

String ruleId

RuleId is one of two values:

• The RuleId of the Rule 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 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 Unix time format (in seconds). You can specify any time range in the previous three hours.

maxItems

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.

Class com.amazonaws.services.waf.model.GetSampledRequestsResult extends Object implements Serializable

Serialized Fields

sampledRequests

List<E> sampledRequests

A complex type that contains detailed information about each of the requests in the sample.

populationSize

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

Class com.amazonaws.services.waf.model.GetSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sizeConstraintSetId

String sizeConstraintSetId

The SizeConstraintSetId of the SizeConstraintSet that you want to get. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

Class com.amazonaws.services.waf.model.GetSizeConstraintSetResult extends Object implements Serializable

Serialized Fields

sizeConstraintSet

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

Class com.amazonaws.services.waf.model.GetSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sqlInjectionMatchSetId

String sqlInjectionMatchSetId

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to get. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

Class com.amazonaws.services.waf.model.GetSqlInjectionMatchSetResult extends Object implements Serializable

Serialized Fields

sqlInjectionMatchSet

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

Class com.amazonaws.services.waf.model.GetWebACLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

webACLId

String webACLId

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

Class com.amazonaws.services.waf.model.GetWebACLResult extends Object implements Serializable

Serialized Fields

webACL

WebACL webACL

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

• WebACL: Contains DefaultAction, MetricName, Name, an array of Rule objects, and WebACLId
• DefaultAction (Data type is WafAction): Contains Type
• Rules: Contains an array of ActivatedRule objects, which contain Action, Priority, and RuleId
• Action: Contains Type

Class com.amazonaws.services.waf.model.HTTPHeader extends Object implements Serializable

Serialized Fields

name

String name

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

value

String value

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

Class com.amazonaws.services.waf.model.HTTPRequest extends Object implements Serializable

Serialized Fields

clientIP

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

country

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.

uRI

String uRI

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

method

String method

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

hTTPVersion

String hTTPVersion

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

headers

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.

Class com.amazonaws.services.waf.model.IPSet extends Object implements Serializable

Serialized Fields

iPSetId

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.

name

String name

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

iPSetDescriptors

List<E> iPSetDescriptors

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate 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

Class com.amazonaws.services.waf.model.IPSetDescriptor extends Object implements Serializable

Serialized Fields

type

String type

Specify IPV4.

value

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.

AWS WAF supports only /8, /16, /24, and /32 IP addresses.

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

Class com.amazonaws.services.waf.model.IPSetSummary extends Object implements Serializable

Serialized Fields

iPSetId

String iPSetId

The IPSetId for an IPSet. You can use IPSetId in a GetIPSet request to get detailed information about an IPSet.

name

String name

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

Class com.amazonaws.services.waf.model.IPSetUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specifies whether to insert or delete an IP address with UpdateIPSet.

iPSetDescriptor

IPSetDescriptor iPSetDescriptor

The IP address type (IPV4) and the IP address range (in CIDR notation) that web requests originate from.

Class com.amazonaws.services.waf.model.ListByteMatchSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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.

limit

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.

Class com.amazonaws.services.waf.model.ListByteMatchSetsResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

byteMatchSets

List<E> byteMatchSets

An array of ByteMatchSetSummary objects.

Class com.amazonaws.services.waf.model.ListIPSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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

limit

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.

Class com.amazonaws.services.waf.model.ListIPSetsResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

iPSets

List<E> iPSets

An array of IPSetSummary objects.

Class com.amazonaws.services.waf.model.ListRulesRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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.

limit

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.

Class com.amazonaws.services.waf.model.ListRulesResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

rules

List<E> rules

An array of RuleSummary objects.

Class com.amazonaws.services.waf.model.ListSizeConstraintSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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 .

limit

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.

Class com.amazonaws.services.waf.model.ListSizeConstraintSetsResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

sizeConstraintSets

List<E> sizeConstraintSets

An array of SizeConstraintSetSummary objects.

Class com.amazonaws.services.waf.model.ListSqlInjectionMatchSetsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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.

limit

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.

Class com.amazonaws.services.waf.model.ListSqlInjectionMatchSetsResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

sqlInjectionMatchSets

List<E> sqlInjectionMatchSets

An array of SqlInjectionMatchSetSummary objects.

Class com.amazonaws.services.waf.model.ListWebACLsRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

nextMarker

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.

limit

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.

Class com.amazonaws.services.waf.model.ListWebACLsResult extends Object implements Serializable

Serialized Fields

nextMarker

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.

webACLs

List<E> webACLs

An array of WebACLSummary objects.

Class com.amazonaws.services.waf.model.Predicate extends Object implements Serializable

Serialized Fields

negated

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, or SqlInjectionMatchSet. 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, or SqlInjectionMatchSet. For example, if an IPSet includes the IP address 192.0.2.44, AWS WAF will allow, block, or count requests based on all IP addresses except 192.0.2.44.

type

String type

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

dataId

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.

Class com.amazonaws.services.waf.model.Rule extends Object implements Serializable

Serialized Fields

ruleId

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.

name

String name

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

metricName

String metricName

predicates

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.

Class com.amazonaws.services.waf.model.RuleSummary extends Object implements Serializable

Serialized Fields

ruleId

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.

name

String name

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

Class com.amazonaws.services.waf.model.RuleUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specify INSERT to add a Predicate to a Rule. Use DELETE to remove a Predicate from a Rule.

predicate

Predicate predicate

The ID of the Predicate (such as an IPSet) that you want to add to a Rule.

Class com.amazonaws.services.waf.model.SampledHTTPRequest extends Object implements Serializable

Serialized Fields

request

HTTPRequest request

A complex type that contains detailed information about the request.

weight

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.

timestamp

Date timestamp

The time at which AWS WAF received the request from your AWS resource, in Unix time format (in seconds).

action

String action

The action for the Rule that the request matched: ALLOW, BLOCK, or COUNT.

Class com.amazonaws.services.waf.model.SizeConstraint extends Object implements Serializable

Serialized Fields

fieldToMatch

FieldToMatch fieldToMatch

textTransformation

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.

comparisonOperator

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

size

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.

Class com.amazonaws.services.waf.model.SizeConstraintSet extends Object implements Serializable

Serialized Fields

sizeConstraintSetId

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.

name

String name

The name, if any, of the SizeConstraintSet.

sizeConstraints

List<E> sizeConstraints

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

Class com.amazonaws.services.waf.model.SizeConstraintSetSummary extends Object implements Serializable

Serialized Fields

sizeConstraintSetId

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.

name

String name

The name of the SizeConstraintSet, if any.

Class com.amazonaws.services.waf.model.SizeConstraintSetUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specify INSERT to add a SizeConstraintSetUpdate to a SizeConstraintSet. Use DELETE to remove a SizeConstraintSetUpdate from a SizeConstraintSet.

sizeConstraint

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.

Class com.amazonaws.services.waf.model.SqlInjectionMatchSet extends Object implements Serializable

Serialized Fields

sqlInjectionMatchSetId

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.

name

String name

The name, if any, of the SqlInjectionMatchSet.

sqlInjectionMatchTuples

List<E> sqlInjectionMatchTuples

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

Class com.amazonaws.services.waf.model.SqlInjectionMatchSetSummary extends Object implements Serializable

Serialized Fields

sqlInjectionMatchSetId

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.

name

String name

The name of the SqlInjectionMatchSet, if any, specified by Id.

Class com.amazonaws.services.waf.model.SqlInjectionMatchSetUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specify INSERT to add a SqlInjectionMatchSetUpdate to a SqlInjectionMatchSet. Use DELETE to remove a SqlInjectionMatchSetUpdate from a SqlInjectionMatchSet.

sqlInjectionMatchTuple

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.

Class com.amazonaws.services.waf.model.SqlInjectionMatchTuple extends Object implements Serializable

Serialized Fields

fieldToMatch

FieldToMatch fieldToMatch

textTransformation

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.

Class com.amazonaws.services.waf.model.TimeWindow extends Object implements Serializable

Serialized Fields

startTime

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. You can specify any time range in the previous three hours.

endTime

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. You can specify any time range in the previous three hours.

Class com.amazonaws.services.waf.model.UpdateByteMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

byteMatchSetId

String byteMatchSetId

The ByteMatchSetId of the ByteMatchSet that you want to update. ByteMatchSetId is returned by CreateByteMatchSet and by ListByteMatchSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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

Class com.amazonaws.services.waf.model.UpdateByteMatchSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.UpdateIPSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

iPSetId

String iPSetId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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

Class com.amazonaws.services.waf.model.UpdateIPSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.UpdateRuleRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

ruleId

String ruleId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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

Class com.amazonaws.services.waf.model.UpdateRuleResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.UpdateSizeConstraintSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sizeConstraintSetId

String sizeConstraintSetId

The SizeConstraintSetId of the SizeConstraintSet that you want to update. SizeConstraintSetId is returned by CreateSizeConstraintSet and by ListSizeConstraintSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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

Class com.amazonaws.services.waf.model.UpdateSizeConstraintSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.UpdateSqlInjectionMatchSetRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

sqlInjectionMatchSetId

String sqlInjectionMatchSetId

The SqlInjectionMatchSetId of the SqlInjectionMatchSet that you want to update. SqlInjectionMatchSetId is returned by CreateSqlInjectionMatchSet and by ListSqlInjectionMatchSets.

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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

Class com.amazonaws.services.waf.model.UpdateSqlInjectionMatchSetResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.UpdateWebACLRequest extends AmazonWebServiceRequest implements Serializable

Serialized Fields

webACLId

String webACLId

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

changeToken

String changeToken

The value returned by the most recent call to GetChangeToken.

updates

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, Priority, and RuleId
• WafAction: Contains Type

defaultAction

WafAction defaultAction

Class com.amazonaws.services.waf.model.UpdateWebACLResult extends Object implements Serializable

Serialized Fields

changeToken

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.

Class com.amazonaws.services.waf.model.WafAction extends Object implements Serializable

Serialized Fields

type

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.

Class com.amazonaws.services.waf.model.WAFDisallowedNameException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFInternalErrorException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFInvalidAccountException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFInvalidOperationException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFInvalidParameterException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Serialized Fields

field

String field

parameter

String parameter

reason

String reason

Class com.amazonaws.services.waf.model.WAFLimitsExceededException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFNonEmptyEntityException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFNonexistentContainerException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFNonexistentItemException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFReferencedItemException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WAFStaleDataException extends AmazonServiceException implements Serializable

serialVersionUID:

1L

Class com.amazonaws.services.waf.model.WebACL extends Object implements Serializable

Serialized Fields

webACLId

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.

name

String name

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

metricName

String metricName

defaultAction

WafAction defaultAction

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

rules

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.

Class com.amazonaws.services.waf.model.WebACLSummary extends Object implements Serializable

Serialized Fields

webACLId

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.

name

String name

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

Class com.amazonaws.services.waf.model.WebACLUpdate extends Object implements Serializable

Serialized Fields

action

String action

Specifies whether to insert a Rule into or delete a Rule from a WebACL.

activatedRule

ActivatedRule activatedRule