String action
The action setting that a log record must contain in order to meet the condition.
CustomRequestHandling customRequestHandling
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
String webACLArn
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
String resourceArn
The Amazon Resource Name (ARN) of the resource to associate with the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API:
arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool:
arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
CustomResponse customResponse
Defines a custom response for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
String oversizeHandling
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.
The options for oversize handling are the following:
CONTINUE - Inspect the body normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over 8 KB.
Default: CONTINUE
ByteBuffer searchString
A string value that you want WAF to search for. WAF searches only in the part of web requests that you designate for inspection in FieldToMatch. The maximum length of the value is 50 bytes.
Valid values depend on the component that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want WAF to search for. This indicates the type of operation
specified in the request.
UriPath: The value that you want WAF to search for in the URI path, for example,
/images/daily-ad.jpg.
If SearchString includes alphabetic characters A-Z and a-z, note that the value is case sensitive.
If you're using the 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 SearchString.
If you're using the CLI or one of the Amazon Web Services SDKs
The value that you want WAF to search for. The SDK automatically base64 encodes the value.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
String positionalConstraint
The area within the portion of the web request that you want WAF to search for SearchString. Valid
values include the following:
CONTAINS
The specified part of the web request must include the value of SearchString, but the location
doesn't matter.
CONTAINS_WORD
The specified part of the web request must include the value of SearchString, and
SearchString must contain only alphanumeric characters or underscore (A-Z, a-z, 0-9, or _). In
addition, SearchString must be a word, which means that both of the following are true:
SearchString is at the beginning of the specified part of the web request or is preceded by a
character other than an alphanumeric character or underscore (_). Examples include the value of a header and
;BadBot.
SearchString is at the end of the specified part of the web request or is followed by a character
other than an alphanumeric character or underscore (_), for example, BadBot; and
-BadBot;.
EXACTLY
The value of the specified part of the web request must exactly match the value of SearchString.
STARTS_WITH
The value of SearchString must appear at the beginning of the specified part of the web request.
ENDS_WITH
The value of SearchString must appear at the end of the specified part of the web request.
CustomRequestHandling customRequestHandling
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
ImmunityTimeProperty immunityTimeProperty
Determines how long a CAPTCHA token remains valid after the client successfully solves a
CAPTCHA puzzle.
Integer responseCode
The HTTP response code indicating the status of the CAPTCHA token in the web request. If the token
is missing, invalid, or expired, this code is 405 Method Not Allowed.
Long solveTimestamp
The time that the CAPTCHA puzzle was solved for the supplied token.
String failureReason
The reason for failure, populated when the evaluation of the token fails.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
List<E> rules
An array of Rule that you're configuring to use in a rule group or web ACL.
Long capacity
The capacity required by the rules and scope.
ActionCondition actionCondition
A single action condition. This is the action setting that a log record must contain in order to meet the condition.
LabelNameCondition labelNameCondition
A single label name condition. This is the fully qualified label name that a log record must contain in order to meet the condition. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
CookieMatchPattern matchPattern
The filter to use to identify the subset of cookies to inspect in a web request.
You must specify exactly one setting: either All, IncludedCookies, or
ExcludedCookies.
Example JSON:
"MatchPattern": { "IncludedCookies": {"KeyToInclude1", "KeyToInclude2", "KeyToInclude3"} }
String matchScope
The parts of the cookies to inspect with the rule inspection criteria. If you specify All, WAF
inspects both keys and values.
String oversizeHandling
What WAF should do if the cookies of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request cookies when they exceed 8 KB (8192 bytes) or 200 total cookies. The underlying host service forwards a maximum of 200 cookies and at most 8 KB of cookie contents to WAF.
The options for oversize handling are the following:
CONTINUE - Inspect the cookies normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
CustomRequestHandling customRequestHandling
Defines custom handling for the web request.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String description
A description of the IP set that helps with identification.
String iPAddressVersion
The version of the IP addresses, either IPV4 or IPV6.
List<E> addresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
To configure 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 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.
To configure 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 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.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""] INVALID
List<E> tags
An array of key:value pairs to associate with the resource.
IPSetSummary summary
High-level information about an IPSet, returned by operations like create and list. This provides
information like the ID, that you can use to retrieve and manage an IPSet, and the ARN, that you
provide to the IPSetReferenceStatement to use the address set in a Rule.
String name
The name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String description
A description of the set that helps with identification.
List<E> regularExpressionList
Array of regular expression strings.
List<E> tags
An array of key:value pairs to associate with the resource.
RegexPatternSetSummary summary
High-level information about a RegexPatternSet, returned by operations like create and list. This provides
information like the ID, that you can use to retrieve and manage a RegexPatternSet, and the ARN,
that you provide to the RegexPatternSetReferenceStatement to use the pattern set in a Rule.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
Long capacity
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
String description
A description of the rule group that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
List<E> tags
An array of key:value pairs to associate with the resource.
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
RuleGroupSummary summary
High-level information about a RuleGroup, returned by operations like create and list. This provides
information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you
provide to the RuleGroupReferenceStatement to use the rule group in a Rule.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
DefaultAction defaultAction
The action to perform if none of the Rules contained in the WebACL match.
String description
A description of the web ACL that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
List<E> tags
An array of key:value pairs to associate with the resource.
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
CaptchaConfig captchaConfig
Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
CaptchaConfig.
WebACLSummary summary
High-level information about a WebACL, returned by operations like create and list. This provides
information like the ID, that you can use to retrieve and manage a WebACL, and the ARN, that you
provide to operations like AssociateWebACL.
String name
The name of the custom header.
For custom request header insertion, when WAF inserts the header into the request, it prefixes this name
x-amzn-waf-, to avoid confusion with the headers that are already in the request. For example, for
the header name sample, WAF inserts the header x-amzn-waf-sample.
String value
The value of the custom header.
List<E> insertHeaders
The HTTP headers to insert into the request. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
Integer responseCode
The HTTP status code to return to the client.
For a list of status codes that you can use in your custom responses, see Supported status codes for custom response in the WAF Developer Guide.
String customResponseBodyKey
References the response body that you want WAF to return to the web request client. You can define a custom
response for a rule action or a default web ACL action that is set to block. To do this, you first define the
response body key and value in the CustomResponseBodies setting for the WebACL or
RuleGroup where you want to use it. Then, in the rule action or web ACL default action
BlockAction setting, you reference the response body using this key.
List<E> responseHeaders
The HTTP headers to use in the response. Duplicate header names are not allowed.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
String contentType
The type of content in the payload that you are defining in the Content string.
String content
The payload of the custom response.
You can use JSON escape strings in JSON content. To do this, you must specify JSON content in the
ContentType setting.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
BlockAction block
Specifies that WAF should block requests by default.
AllowAction allow
Specifies that WAF should allow requests by default.
String webACLArn
The Amazon Resource Name (ARN) of the web ACL.
String webACLLockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String nextWebACLLockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String resourceArn
The Amazon Resource Name (ARN) of the web ACL from which you want to delete the LoggingConfiguration.
String resourceArn
The Amazon Resource Name (ARN) of the rule group from which you want to delete the policy.
You must be the owner of the rule group to perform this operation.
String name
The name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String vendorName
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
String name
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String versionName
The version of the rule group. You can only use a version that is not scheduled for expiration. If you don't provide this, WAF uses the vendor's default version.
String versionName
The managed rule group's version.
String snsTopicArn
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide.
Long capacity
The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
List<E> rules
String labelNamespace
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
List<E> availableLabels
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels for a Rule.
List<E> consumedLabels
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement specification, in the Statement definition of a rule.
String resourceArn
The Amazon Resource Name (ARN) of the resource to disassociate from the web ACL.
The ARN must be in one of the following formats:
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API:
arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool:
arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
String name
The name of the rule whose action you want to override to Count.
SingleHeader singleHeader
Inspect a single header. Provide the name of the header to inspect, for example, User-Agent or
Referer. This setting isn't case sensitive.
Example JSON: "SingleHeader": { "Name": "haystack" }
Alternately, you can filter and inspect all headers with the Headers FieldToMatch
setting.
SingleQueryArgument singleQueryArgument
Inspect a single query argument. Provide the name of the query argument to inspect, such as UserName or SalesRegion. The name can be up to 30 characters long and isn't case sensitive.
Example JSON: "SingleQueryArgument": { "Name": "myArgument" }
AllQueryArguments allQueryArguments
Inspect all query arguments.
UriPath uriPath
Inspect the request URI path. This is the part of the web request that identifies a resource, for example,
/images/daily-ad.jpg.
QueryString queryString
Inspect the query string. This is the part of a URL that appears after a ? character, if any.
Body body
Inspect the request body as plain text. The request body immediately follows the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host
service. For information about how to handle oversized request bodies, see the Body object
configuration.
Method method
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
JsonBody jsonBody
Inspect the request body as JSON. The request body immediately follows the request headers. This is 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.
Only the first 8 KB (8192 bytes) of the request body are forwarded to WAF for inspection by the underlying host
service. For information about how to handle oversized request bodies, see the JsonBody object
configuration.
Headers headers
Inspect the request headers. You must configure scope and pattern matching filters in the Headers
object, to define the set of headers to and the parts of the headers that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's headers and only the first 200 headers are forwarded to WAF for
inspection by the underlying host service. You must configure how to handle any oversize header content in the
Headers object. WAF applies the pattern matching filters to the headers that it receives from the
underlying host service.
Cookies cookies
Inspect the request cookies. You must configure scope and pattern matching filters in the Cookies
object, to define the set of cookies and the parts of the cookies that WAF inspects.
Only the first 8 KB (8192 bytes) of a request's cookies and only the first 200 cookies are forwarded to WAF for
inspection by the underlying host service. You must configure how to handle any oversize cookie content in the
Cookies object. WAF applies the pattern matching filters to the cookies that it receives from the
underlying host service.
String behavior
How to handle logs that satisfy the filter's conditions and requirement.
String requirement
Logic to apply to the filtering conditions. You can specify that, in order to satisfy the filter, a log must match all conditions or must match at least one condition.
List<E> conditions
Match conditions for the filter.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
Integer priority
If you define more than one rule group in the first or last Firewall Manager rule groups, WAF evaluates each request against the rule groups in order, starting from the lowest priority setting. The priorities don't need to be consecutive, but they must all be different.
FirewallManagerStatement firewallManagerStatement
The processing guidance for an Firewall Manager rule. This is like a regular rule Statement, but it can only contain a rule group reference.
OverrideAction overrideAction
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
ManagedRuleGroupStatement managedRuleGroupStatement
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement
or OrStatement. It can only be referenced as a top-level statement within a rule.
RuleGroupReferenceStatement ruleGroupReferenceStatement
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a
NotStatement or OrStatement. You can only use a rule group reference statement at the
top level inside a web ACL.
String headerName
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set
this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
String fallbackBehavior
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
String url
The presigned download URL for the specified SDK release.
List<E> countryCodes
An array of two-character country codes, for example, [ "US", "CN" ], from the alpha-2 country ISO
codes of the ISO 3166 international standard.
ForwardedIPConfig forwardedIPConfig
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
IPSet iPSet
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String resourceArn
The Amazon Resource Name (ARN) of the web ACL for which you want to get the LoggingConfiguration.
LoggingConfiguration loggingConfiguration
The LoggingConfiguration for the specified web ACL.
String name
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations like get and update.
ManagedRuleSet managedRuleSet
The managed rule set that you requested.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
MobileSdkRelease mobileSdkRelease
Information for a specified SDK release, including release notes and tags.
String resourceArn
The Amazon Resource Name (ARN) of the rule group for which you want to get the policy.
String policy
The IAM policy that is attached to the specified rule group.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String webACLName
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String webACLId
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String ruleGroupRuleName
The name of the rule group reference statement in your web ACL. This is required only when you have the rate-based rule nested inside a rule group.
String ruleName
The name of the rate-based rule to get the keys for. If you have the rule defined inside a rule group that you're
using in your web ACL, also provide the name of the rule group reference statement in the request parameter
RuleGroupRuleName.
RateBasedStatementManagedKeysIPSet managedKeysIPV4
The keys that are of Internet Protocol version 4 (IPv4).
RateBasedStatementManagedKeysIPSet managedKeysIPV6
The keys that are of Internet Protocol version 6 (IPv6).
String name
The name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
RegexPatternSet regexPatternSet
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String aRN
The Amazon Resource Name (ARN) of the entity.
RuleGroup ruleGroup
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String webAclArn
The Amazon resource name (ARN) of the WebACL for which you want a sample of requests.
String ruleMetricName
The metric name assigned to the Rule or RuleGroup for which you want a sample of
requests.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
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. You must specify the times in Coordinated Universal Time (UTC) format. UTC format
includes the special designator, Z. For example, "2016-09-27T14:50Z". You can specify
any time range in the previous three hours. If you specify a start time that's earlier than three hours ago, WAF
sets it to three hours ago.
Long maxItems
The number of requests that you want WAF to return from among the first 5,000 requests that your Amazon Web
Services 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 Amazon Web Services 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 Amazon Web Services 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. Times are in Coordinated Universal Time (UTC) format.
String resourceArn
The Amazon Resource Name (ARN) of the resource whose web ACL you want to retrieve.
The ARN must be in one of the following formats:
For an Application Load Balancer:
arn:aws:elasticloadbalancing:region:account-id:loadbalancer/app/load-balancer-name/load-balancer-id
For an Amazon API Gateway REST API:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
For an AppSync GraphQL API:
arn:aws:appsync:region:account-id:apis/GraphQLApiId
For an Amazon Cognito user pool:
arn:aws:cognito-idp:region:account-id:userpool/user-pool-id
WebACL webACL
The web ACL that is associated with the resource. If there is no associated resource, WAF returns a null web ACL.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
WebACL webACL
The web ACL specification. You can modify the settings in this web ACL and use it to update this web ACL or create a new one.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String applicationIntegrationURL
The URL to use in SDK integrations with Amazon Web Services managed rule groups. For example, you can use the
integration SDKs with the account takeover prevention managed rule group AWSManagedRulesATPRuleSet.
This is only populated if you are using a rule group in your web ACL that integrates with your applications in
this way. For more information, see WAF client
application integration in the WAF Developer Guide.
HeaderMatchPattern matchPattern
The filter to use to identify the subset of headers to inspect in a web request.
You must specify exactly one setting: either All, IncludedHeaders, or
ExcludedHeaders.
Example JSON: "MatchPattern": { "ExcludedHeaders": {"KeyToExclude1", "KeyToExclude2"} }
String matchScope
The parts of the headers to match with the rule inspection criteria. If you specify All, WAF
inspects both keys and values.
String oversizeHandling
What WAF should do if the headers of the request are larger than WAF can inspect. WAF does not support inspecting the entire contents of request headers when they exceed 8 KB (8192 bytes) or 200 total headers. The underlying host service forwards a maximum of 200 headers and at most 8 KB of header contents to WAF.
The options for oversize handling are the following:
CONTINUE - Inspect the headers normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
String clientIP
The IP address that the request originated from. If the web ACL 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 URI path of the request, which identifies the resource, for example, /images/daily-ad.jpg.
String method
The HTTP method specified in the sampled web request.
String hTTPVersion
The HTTP version specified in the sampled web request, for example, HTTP/1.1.
List<E> headers
A complex type that contains the name and value for each header in the sampled web request.
Long immunityTime
The amount of time, in seconds, that a CAPTCHA token is valid. The default setting is 300.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String aRN
The Amazon Resource Name (ARN) of the entity.
String description
A description of the IP set that helps with identification.
String iPAddressVersion
The version of the IP addresses, either IPV4 or IPV6.
List<E> addresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
To configure 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 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.
To configure 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 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.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""] INVALID
String headerName
The name of the HTTP header to use for the IP address. For example, to use the X-Forwarded-For (XFF) header, set
this to X-Forwarded-For.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
String fallbackBehavior
The match status to assign to the web request if the request doesn't have a valid IP address in the specified position.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
You can specify the following fallback behaviors:
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
String position
The position in the header to search for the IP address. The header can contain IP addresses of the original
client and also of proxies. For example, the header value could be 10.1.1.1, 127.0.0.0, 10.10.10.10
where the first IP address identifies the original client and the rest identify proxies that the request went
through.
The options for this setting are the following:
FIRST - Inspect the first IP address in the list of IP addresses in the header. This is usually the client's original IP.
LAST - Inspect the last IP address in the list of IP addresses in the header.
ANY - Inspect all IP addresses in the header for a match. If the header contains more than 10 IP addresses, WAF inspects the last 10.
String aRN
The Amazon Resource Name (ARN) of the IPSet that this statement references.
IPSetForwardedIPConfig iPSetForwardedIPConfig
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the IP set that helps with identification.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String aRN
The Amazon Resource Name (ARN) of the entity.
JsonMatchPattern matchPattern
The patterns to look for in the JSON body. WAF inspects the results of these pattern matches against the rule inspection criteria.
String matchScope
The parts of the JSON to match against using the MatchPattern. If you specify All, WAF
matches against keys and values.
String invalidFallbackBehavior
What WAF should do if it fails to completely parse the JSON body. The options are the following:
EVALUATE_AS_STRING - Inspect the body as plain text. WAF applies the text transformations and
inspection criteria that you defined for the JSON inspection to the body text string.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
If you don't provide this setting, WAF parses and evaluates the content only up to the first parsing failure that it encounters.
WAF does its best to parse the entire JSON body, but might be forced to stop for reasons such as invalid characters, duplicate keys, truncation, and any content whose root node isn't an object or an array.
WAF parses the JSON in the following examples as two valid key, value pairs:
Missing comma: {"key1":"value1""key2":"value2"}
Missing colon: {"key1":"value1","key2""value2"}
Extra colons: {"key1"::"value1","key2""value2"}
String oversizeHandling
What WAF should do if the body is larger than WAF can inspect. WAF does not support inspecting the entire contents of the body of a web request when the body exceeds 8 KB (8192 bytes). Only the first 8 KB of the request body are forwarded to WAF by the underlying host service.
The options for oversize handling are the following:
CONTINUE - Inspect the body normally, according to the rule inspection criteria.
MATCH - Treat the web request as matching the rule statement. WAF applies the rule action to the
request.
NO_MATCH - Treat the web request as not matching the rule statement.
You can combine the MATCH or NO_MATCH settings for oversize handling with your rule and
web ACL action settings, so that you block any request whose body is over 8 KB.
Default: CONTINUE
All all
Match all of the elements. See also MatchScope in JsonBody.
You must specify either this setting or the IncludedPaths setting, but not both.
List<E> includedPaths
Match only the specified include paths. See also MatchScope in JsonBody.
Provide the include paths using JSON Pointer syntax. For example,
"IncludedPaths": ["/dogs/0/name", "/dogs/1/name"]. For information about this syntax, see the
Internet Engineering Task Force (IETF) documentation JavaScript
Object Notation (JSON) Pointer.
You must specify either this setting or the All setting, but not both.
Don't use this option to include all paths. Instead, use the All setting.
String name
The label string.
String scope
Specify whether you want to match using the label name or just the namespace.
String key
The string to match against. The setting you provide for this depends on the match statement's Scope
setting:
If the Scope indicates LABEL, then this specification must include the name and can
include any number of preceding namespace specifications and prefix up to providing the fully qualified label
name.
If the Scope indicates NAMESPACE, then this specification can include any number of
contiguous namespace strings, and can include the entire label namespace prefix from the rule group or web ACL
where the label originates.
Labels are case sensitive and components of a label must be separated by colon, for example
NS1:NS2:name.
String labelName
The label name that a log record must contain in order to meet the condition. This must be a fully qualified label name. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label.
String name
An individual label specification.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> managedRuleGroups
String vendorName
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
String name
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> versions
The versions that are currently available for the specified managed rule group.
String currentDefaultVersion
The name of the version that's currently set as the default.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> iPSets
Array of IPSets. This may not be the full list of IPSets that you have defined. See the Limit
specification for this request.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
List<E> loggingConfigurations
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> managedRuleSets
Your managed rule sets.
String platform
The device platform to retrieve the list for.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
List<E> releaseSummaries
High level information for the available SDK releases.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> regexPatternSets
String webACLArn
The Amazon Resource Name (ARN) of the web ACL.
String resourceType
Used for web ACLs that are scoped for regional applications. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> ruleGroups
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String resourceARN
The Amazon Resource Name (ARN) of the resource.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
TagInfoForResource tagInfoForResource
The collection of tagging definitions for the resource.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
Integer limit
The maximum number of objects that you want WAF to return for this request. If more objects are available, in the
response, WAF provides a NextMarker value that you can use in a subsequent call to get the next
batch of objects.
String nextMarker
When you request a list of objects with a Limit setting, if the number of objects that are still
available for retrieval exceeds the limit, WAF returns a NextMarker value in the response. To
retrieve the next batch of objects, provide the marker from the prior call in your next request.
List<E> webACLs
String resourceArn
The Amazon Resource Name (ARN) of the web ACL that you want to associate with LogDestinationConfigs.
List<E> logDestinationConfigs
The logging destination configuration that you want to associate with the web ACL.
You can associate one logging destination to a web ACL.
List<E> redactedFields
The parts of the request that you want to keep out of the logs. For example, if you redact the
SingleHeader field, the HEADER field in the logs will be xxx.
You can specify only the following fields for redaction: UriPath, QueryString,
SingleHeader, Method, and JsonBody.
Boolean managedByFirewallManager
Indicates whether the logging configuration was created by Firewall Manager, as part of an WAF policy configuration. If true, only Firewall Manager can modify or delete the configuration.
LoggingFilter loggingFilter
Filtering that specifies which web requests are kept in the logs and which are dropped. You can filter on the rule action and on the web request labels that were applied by matching rules during web ACL evaluation.
String loginPath
The path of the login endpoint for your application. For example, for the URL
https://example.com/web/login, you would provide the path /web/login.
String payloadType
The payload type for your login endpoint, either JSON or form encoded.
UsernameField usernameField
Details about your login page username field.
PasswordField passwordField
Details about your login page password field.
String vendorName
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
String name
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
String version
The version of the managed rule group to use. If you specify this, the version setting is fixed until you change it. If you don't specify this, WAF uses the vendor's default version, and then keeps the version at the vendor's default when the vendor updates the managed rule group settings.
List<E> excludedRules
The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF
evaluates it exactly as it would if the rule action setting were Count. This is a useful option for
testing the rules in a rule group without modifying how they handle your web traffic.
Statement scopeDownStatement
An optional nested statement that narrows the scope of the web requests that are evaluated by the managed rule group. Requests are only evaluated by the rule group if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
List<E> managedRuleGroupConfigs
Additional information that's used by a managed rule group. Most managed rule groups don't require this.
Use this for the account takeover prevention managed rule group AWSManagedRulesATPRuleSet, to
provide information about the sign-in page of your application.
You can provide multiple individual ManagedRuleGroupConfig objects for any rule group configuration,
for example UsernameField and PasswordField. The configuration that you provide depends
on the needs of the managed rule group. For the ATP managed rule group, you provide the following individual
configuration objects: LoginPath, PasswordField, PayloadType and
UsernameField.
String vendorName
The name of the managed rule group vendor. You use this, along with the rule group name, to identify the rule group.
String name
The name of the managed rule group. You use this, along with the vendor name, to identify the rule group.
Boolean versioningSupported
Indicates whether the managed rule group is versioned. If it is, you can retrieve the versions list by calling ListAvailableManagedRuleGroupVersions.
String description
The description of the managed rule group, provided by Amazon Web Services Managed Rules or the Amazon Web Services Marketplace seller who manages it.
String name
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
String id
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations like get and update.
String aRN
The Amazon Resource Name (ARN) of the entity.
String description
A description of the set that helps with identification.
Map<K,V> publishedVersions
The versions of this managed rule set that are available for use by customers.
String recommendedVersion
The version that you would like your customers to use.
String labelNamespace
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
String name
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
String id
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations like get and update.
String description
A description of the set that helps with identification.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String aRN
The Amazon Resource Name (ARN) of the entity.
String labelNamespace
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
String associatedRuleGroupArn
The Amazon Resource Name (ARN) of the vendor rule group that's used to define the published version of your managed rule group.
Long capacity
The web ACL capacity units (WCUs) required for this rule group.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
Integer forecastedLifetime
The amount of time you expect this version of your managed rule group to last, in days.
Date publishTimestamp
The time that you first published this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Date lastUpdateTimestamp
The last time that you updated this version.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Date expiryTimestamp
The time that this version is set to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
Statement statement
The statement to negate. You can use any statement that can be nested.
CountAction count
Override the rule group evaluation result to count only.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
NoneAction none
Don't override the rule group evaluation result. This is the most common setting.
String identifier
The name of the password field. For example /form/password.
LoggingConfiguration loggingConfiguration
LoggingConfiguration loggingConfiguration
String name
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations like get and update.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String recommendedVersion
The version of the named managed rule group that you'd like your customers to choose, from among your version offerings.
Map<K,V> versionsToPublish
The versions of the named managed rule group that you want to offer to your customers.
String nextLockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String resourceArn
The Amazon Resource Name (ARN) of the RuleGroup to which you want to attach the policy.
String policy
The policy to attach to the specified rule group.
The policy specifications must conform to the following:
The policy must be composed using IAM Policy version 2012-10-17 or version 2015-01-01.
The policy must include specifications for Effect, Action, and Principal.
Effect must specify Allow.
Action must specify wafv2:CreateWebACL, wafv2:UpdateWebACL, and
wafv2:PutFirewallManagerRuleGroups and may optionally specify wafv2:GetRuleGroup. WAF
rejects any extra actions or wildcard actions in the policy.
The policy must not include a Resource parameter.
For more information, see IAM Policies.
Long limit
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a
ScopeDownStatement, this limit is applied only to the requests that match the statement.
String aggregateKeyType
Setting that indicates how to aggregate the request counts. The options are the following:
IP - Aggregate the request counts on the IP address from the web request origin.
FORWARDED_IP - Aggregate the request counts on the first IP address in an HTTP header. If you use this, configure
the ForwardedIPConfig, to specify the header to use.
Statement scopeDownStatement
An optional nested statement that narrows the scope of the web requests that are evaluated by the rate-based statement. Requests are only tracked by the rate-based statement if they match the scope-down statement. You can use any nestable Statement in the scope-down statement, and you can nest statements at any level, the same as you can for a rule statement.
ForwardedIPConfig forwardedIPConfig
The configuration for inspecting IP addresses in an HTTP header that you specify, instead of using the IP address that's reported by the web request origin. Commonly, this is the X-Forwarded-For (XFF) header, but you can specify any header name.
If the specified header isn't present in the request, WAF doesn't apply the rule to the web request at all.
This is required if AggregateKeyType is set to FORWARDED_IP.
String regexString
The string representing the regular expression.
String regexString
The string representing the regular expression.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
String name
The name of the set. You cannot change the name after you create the set.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String aRN
The Amazon Resource Name (ARN) of the entity.
String description
A description of the set that helps with identification.
List<E> regularExpressionList
The regular expression patterns in the set.
String aRN
The Amazon Resource Name (ARN) of the RegexPatternSet that this statement references.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
String name
The name of the data type instance. You cannot change the name after you create the instance.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the set that helps with identification.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String aRN
The Amazon Resource Name (ARN) of the entity.
String name
The name of the rule. You can't change the name of a Rule after you create it.
Integer priority
If you define more than one Rule in a WebACL, WAF evaluates each request against the
Rules in order based on the value of Priority. WAF processes rules with lower priority
first. The priorities don't need to be consecutive, but they must all be different.
Statement statement
The WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
RuleAction action
The action that WAF should take on a web request when it matches the rule statement. Settings at the web ACL level can override the rule action setting.
This is used only for rules whose statements do not reference a rule group. Rule statements that reference a rule
group include RuleGroupReferenceStatement and ManagedRuleGroupStatement.
You must specify either this Action setting or the rule OverrideAction setting, but not
both:
If the rule statement does not reference a rule group, use this rule action setting and not the rule override action setting.
If the rule statement references a rule group, use the override action setting and not this action setting.
OverrideAction overrideAction
The action to use in the place of the action that results from the rule group evaluation. Set the override action to none to leave the result of the rule group alone. Set it to count to override the result to count only.
You can only use this for rule statements that reference a rule group, like
RuleGroupReferenceStatement and ManagedRuleGroupStatement.
This option is usually set to none. It does not affect how the rules in the rule group are evaluated. If you want the rules in the rule group to only count matches, do not use this and instead exclude those rules in your rule group reference statement settings.
List<E> ruleLabels
Labels to apply to web requests that match the rule match statement. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
Rules that run after this rule in the web ACL can match against these labels using a
LabelMatchStatement.
For each label, provide a case-sensitive string containing optional namespaces and a label name, according to the following guidelines:
Separate each component of the label with a colon.
Each namespace or name can have up to 128 characters.
You can specify up to 5 namespaces in a label.
Don't use the following reserved words in your label specification: aws, waf,
managed, rulegroup, webacl, regexpatternset, or
ipset.
For example, myLabelName or nameSpace1:nameSpace2:myLabelName.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
CaptchaConfig captchaConfig
Specifies how WAF should handle CAPTCHA evaluations. If you don't specify this, WAF uses the
CAPTCHA configuration that's defined for the web ACL.
BlockAction block
Instructs WAF to block the web request.
AllowAction allow
Instructs WAF to allow the web request.
CountAction count
Instructs WAF to count the web request and allow it.
CaptchaAction captcha
Instructs WAF to run a CAPTCHA check against the web request.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String id
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
Long capacity
The web ACL capacity units (WCUs) required for this rule group.
When you create your own rule group, you define this, and you cannot change it after creation. When you add or modify the rules in a rule group, WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
String aRN
The Amazon Resource Name (ARN) of the entity.
String description
A description of the rule group that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String labelNamespace
The label namespace prefix for this rule group. All labels added by rules in this rule group have this prefix.
The syntax for the label namespace prefix for your rule groups is the following:
awswaf:<account ID>:rulegroup:<rule group name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
List<E> availableLabels
The labels that one or more rules in this rule group add to matching web requests. These labels are defined in
the RuleLabels for a Rule.
List<E> consumedLabels
The labels that one or more rules in this rule group match against in label match statements. These labels are
defined in a LabelMatchStatement specification, in the Statement definition of a rule.
String aRN
The Amazon Resource Name (ARN) of the entity.
List<E> excludedRules
The rules in the referenced rule group whose actions are set to Count. When you exclude a rule, WAF
evaluates it exactly as it would if the rule action setting were Count. This is a useful option for
testing the rules in a rule group without modifying how they handle your web traffic.
String name
The name of the data type instance. You cannot change the name after you create the instance.
String id
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the rule group that helps with identification.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String aRN
The Amazon Resource Name (ARN) of the entity.
String name
The name of the rule.
RuleAction action
The action that WAF should take on a web request when it matches a rule's statement. Settings at the web ACL level can override the rule action setting.
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.
For example, a result that has a weight of 2 represents roughly twice as many web requests as a
result that has a weight of 1.
Date timestamp
The time at which WAF received the request from your Amazon Web Services resource, in Unix time format (in seconds).
String action
The action for the Rule that the request matched: Allow, Block, or
Count.
String ruleNameWithinRuleGroup
The name of the Rule that the request matched. For managed rule groups, the format for this name is
<vendor name>#<managed rule group name>#<rule name>. For your own rule groups, the
format for this name is <rule group name>#<rule name>. If the rule is not in a rule
group, this field is absent.
List<E> requestHeadersInserted
Custom request headers inserted by WAF into the request, according to the custom request configuration for the matching rule action.
Integer responseCodeSent
The response code that was sent for the request.
List<E> labels
Labels applied to the web request by matching rules. WAF applies fully qualified labels to matching web requests. A fully qualified label is the concatenation of a label namespace and a rule label. The rule's rule group or web ACL defines the label namespace.
For example, awswaf:111122223333:myRuleGroup:testRules:testNS1:testNS2:labelNameA or
awswaf:managed:aws:managed-rule-set:header:encoding:utf8.
CaptchaResponse captchaResponse
The CAPTCHA response for the request.
String name
The name of the query header to inspect.
String name
The name of the query argument to inspect.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
String comparisonOperator
The operator to use to compare the request part to the size setting.
Long size
The size, in byte, to compare to the request part, after any transformations.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
String sensitivityLevel
The sensitivity that you want WAF to use to inspect for SQL injection attacks.
HIGH detects more attacks, but might generate more false positives, especially if your web requests
frequently contain unusual strings. For information about identifying and mitigating false positives, see Testing and tuning in the
WAF Developer Guide.
LOW is generally a better choice for resources that already have other protections against SQL
injection attacks or that have a low tolerance for false positives.
Default: LOW
ByteMatchStatement byteMatchStatement
A rule statement that defines a string match search for WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the WAF console and the developer guide, this is called a string match statement.
SqliMatchStatement sqliMatchStatement
A rule statement that inspects for malicious SQL code. Attackers insert malicious SQL code into web requests to do things like modify your database or extract data from it.
XssMatchStatement xssMatchStatement
A rule statement that inspects for cross-site scripting (XSS) attacks. In XSS attacks, the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers.
SizeConstraintStatement sizeConstraintStatement
A rule statement that compares a number of bytes against the size of a request component, using a comparison operator, such as greater than (>) or less than (<). For example, you can use a size constraint statement to look for query strings that are longer than 100 bytes.
If you configure WAF to inspect the request body, WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you could use a size constraint statement to block requests that have a request body greater than 8192 bytes.
If you choose URI for the value of Part of the request to filter on, the slash (/) in the URI counts as one
character. For example, the URI /logo.jpg is nine characters long.
GeoMatchStatement geoMatchStatement
A rule statement used to identify web requests based on country of origin.
RuleGroupReferenceStatement ruleGroupReferenceStatement
A rule statement used to run the rules that are defined in a RuleGroup. To use this, create a rule group with your rules, then provide the ARN of the rule group in this statement.
You cannot nest a RuleGroupReferenceStatement, for example for use inside a
NotStatement or OrStatement. You can only use a rule group reference statement at the
top level inside a web ACL.
IPSetReferenceStatement iPSetReferenceStatement
A rule statement used to detect web requests coming from particular IP addresses or address ranges. To use this, create an IPSet that specifies the addresses you want to detect, then use the ARN of that set in this statement. To create an IP set, see CreateIPSet.
Each IP set rule statement references an IP set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
RegexPatternSetReferenceStatement regexPatternSetReferenceStatement
A rule statement used to search web request components for matches with regular expressions. To use this, create a RegexPatternSet that specifies the expressions that you want to detect, then use the ARN of that set in this statement. A web request matches the pattern set rule statement if the request component matches any of the patterns in the set. To create a regex pattern set, see CreateRegexPatternSet.
Each regex pattern set rule statement references a regex pattern set. You create and maintain the set independent of your rules. This allows you to use the single set in multiple rules. When you update the referenced set, WAF automatically updates all rules that reference it.
RateBasedStatement rateBasedStatement
A rate-based rule tracks the rate of requests for each originating IP address, and triggers the rule action when the rate exceeds a limit that you specify on the number of requests in any 5-minute time span. You can use this to put a temporary block on requests from an IP address that is sending excessive requests.
WAF tracks and manages web requests separately for each instance of a rate-based rule that you use. For example, if you provide the same rate-based rule settings in two web ACLs, each of the two rule statements represents a separate instance of the rate-based rule and gets its own tracking and management by WAF. If you define a rate-based rule inside a rule group, and then use that rule group in multiple places, each use creates a separate instance of the rate-based rule that gets its own tracking and management by WAF.
When the rule action triggers, WAF blocks additional requests from the IP address until the request rate falls below the limit.
You can optionally nest another statement inside the rate-based statement, to narrow the scope of the rule so that it only counts requests that match the nested statement. For example, based on recent requests that you have seen from an attacker, you might create a rate-based rule with a nested AND rule statement that contains the following nested statements:
An IP match statement with an IP set that specified the address 192.0.2.44.
A string match statement that searches in the User-Agent header for the string BadBot.
In this rate-based rule, you also define a rate limit. For this example, the rate limit is 1,000. Requests that meet the criteria of both of the nested statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet the criteria of both of the nested statements are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement inside another statement, for example inside a
NotStatement or OrStatement. You can define a RateBasedStatement inside a
web ACL and inside a rule group.
AndStatement andStatement
A logical rule statement used to combine other rule statements with AND logic. You provide more than one
Statement within the AndStatement.
OrStatement orStatement
A logical rule statement used to combine other rule statements with OR logic. You provide more than one
Statement within the OrStatement.
NotStatement notStatement
A logical rule statement used to negate the results of another rule statement. You provide one Statement
within the NotStatement.
ManagedRuleGroupStatement managedRuleGroupStatement
A rule statement used to run the rules that are defined in a managed rule group. To use this, provide the vendor name and the name of the rule group in this statement. You can retrieve the required names by calling ListAvailableManagedRuleGroups.
You cannot nest a ManagedRuleGroupStatement, for example for use inside a NotStatement
or OrStatement. It can only be referenced as a top-level statement within a rule.
LabelMatchStatement labelMatchStatement
A rule statement that defines a string match search against labels that have been added to the web request by rules that have already run in the web ACL.
The label match statement provides the label or namespace string to search for. The label string can represent a part or all of the fully qualified label name that had been added to the web request. Fully qualified labels have a prefix, optional namespaces, and label name. The prefix identifies the rule group or web ACL context of the rule that added the label. If you do not provide the fully qualified name in your label match string, WAF performs the search for labels that were added in the same context as the label match statement.
RegexMatchStatement regexMatchStatement
A rule statement used to search web request components for a match against a single regular expression.
String key
Part of the key:value pair that defines a tag. You can use a tag key to describe a category of information, such as "customer." Tag keys are case-sensitive.
String value
Part of the key:value pair that defines a tag. You can use a tag value to describe a specific value within a category, such as "companyA" or "companyB." Tag values are case-sensitive.
Integer priority
Sets the relative processing order for multiple transformations that are defined for a rule statement. WAF processes all transformations, from lowest priority to highest, before inspecting the transformed content. The priorities don't need to be consecutive, but they must all be different.
String type
You can specify the following transformation types:
BASE64_DECODE - Decode a Base64-encoded string.
BASE64_DECODE_EXT - Decode a Base64-encoded string, but use a forgiving implementation that
ignores characters that aren't valid.
CMD_LINE - Command-line transformations. These are helpful in reducing effectiveness of attackers who inject an operating system command-line command and use unusual formatting to disguise some or all of the command.
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 - Replace these 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.
CSS_DECODE - Decode characters that were encoded using CSS 2.x escape rules
syndata.html#characters. This function uses up to two bytes in the decoding process, so it can help
to uncover ASCII characters that were encoded using CSS encoding that wouldn’t typically be encoded. It's also
useful in countering evasion, which is a combination of a backslash and non-hexadecimal characters. For example,
ja\vascript for javascript.
ESCAPE_SEQ_DECODE - Decode the following ANSI C escape sequences: \a, \b,
\f, \n, \r, \t, \v, \\,
\?, \', \", \xHH (hexadecimal), \0OOO (octal).
Encodings that aren't valid remain in the output.
HEX_DECODE - Decode a string of hexadecimal characters into a binary.
HTML_ENTITY_DECODE - Replace HTML-encoded characters with unencoded characters.
HTML_ENTITY_DECODE performs these 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
JS_DECODE - Decode JavaScript escape sequences. If a \ u HHHH code
is in the full-width ASCII code range of FF01-FF5E, then the higher byte is used to detect and
adjust the lower byte. If not, only the lower byte is used and the higher byte is zeroed, causing a possible loss
of information.
LOWERCASE - Convert uppercase letters (A-Z) to lowercase (a-z).
MD5 - Calculate an MD5 hash from the data in the input. The computed hash is in a raw binary form.
NONE - Specify NONE if you don't want any text transformations.
NORMALIZE_PATH - Remove multiple slashes, directory self-references, and directory back-references that are not at the beginning of the input from an input string.
NORMALIZE_PATH_WIN - This is the same as NORMALIZE_PATH, but first converts backslash
characters to forward slashes.
REMOVE_NULLS - Remove all NULL bytes from the input.
REPLACE_COMMENTS - Replace each occurrence of a C-style comment (/* ... */) with a single
space. Multiple consecutive occurrences are not compressed. Unterminated comments are also replaced with a space
(ASCII 0x20). However, a standalone termination of a comment (*/) is not acted upon.
REPLACE_NULLS - Replace NULL bytes in the input with space characters (ASCII 0x20).
SQL_HEX_DECODE - Decode SQL hex data. Example (0x414243) will be decoded to (ABC
).
URL_DECODE - Decode a URL-encoded value.
URL_DECODE_UNI - Like URL_DECODE, but with support for Microsoft-specific %u
encoding. If the code is in the full-width ASCII code range of FF01-FF5E, the higher byte is used to
detect and adjust the lower byte. Otherwise, only the lower byte is used and the higher byte is zeroed.
UTF8_TO_UNICODE - Convert all UTF-8 character sequences to Unicode. This helps input normalization, and minimizing false-positives and false-negatives for non-English languages.
Date startTime
The beginning of the time range from which you want GetSampledRequests to return a sample of the
requests that your Amazon Web Services resource received. You must specify the times in Coordinated Universal
Time (UTC) format. UTC format includes the special designator, Z. For example,
"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 Amazon Web Services resource received. You must specify the times in Coordinated Universal Time (UTC)
format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z"
. You can specify any time range in the previous three hours.
String name
The name of the IP set. You cannot change the name of an IPSet after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the IP set that helps with identification.
List<E> addresses
Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
Example address strings:
To configure 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 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.
To configure 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 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.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses specifications:
Empty array: "Addresses": []
Array with one address: "Addresses": ["192.0.2.44/32"]
Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
INVALID specification: "Addresses": [""] INVALID
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String nextLockToken
A token used for optimistic locking. WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the managed rule set. The ID is returned in the responses to commands like
list. You provide it to operations like get and update.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String versionToExpire
The version that you want to remove from your list of offerings for the named managed rule group.
Date expiryTimestamp
The time that you want the version to expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
String expiringVersion
The version that is set to expire.
Date expiryTimestamp
The time that the version will expire.
Times are in Coordinated Universal Time (UTC) format. UTC format includes the special designator, Z. For example, "2016-09-27T14:50Z".
String nextLockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String name
The name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the set that helps with identification.
List<E> regularExpressionList
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String nextLockToken
A token used for optimistic locking. WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
The name of the rule group. You cannot change the name of a rule group after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the rule group that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the rule group, and then use them in the rules that you define in the rule group.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
String nextLockToken
A token used for optimistic locking. WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String scope
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
API and SDKs - For all calls, use the Region endpoint us-east-1.
String id
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
DefaultAction defaultAction
The action to perform if none of the Rules contained in the WebACL match.
String description
A description of the web ACL that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
CaptchaConfig captchaConfig
Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
CaptchaConfig.
String nextLockToken
A token used for optimistic locking. WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String identifier
The name of the username field. For example /form/username.
String associatedRuleGroupArn
The Amazon Resource Name (ARN) of the vendor's rule group that's used in the published managed rule group version.
Integer forecastedLifetime
The amount of time the vendor expects this version of the managed rule group to last, in days.
Boolean sampledRequestsEnabled
A boolean indicating whether WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the WAF console.
Boolean cloudWatchMetricsEnabled
A boolean indicating whether the associated resource sends metrics to Amazon CloudWatch. For the list of available metrics, see WAF Metrics.
String metricName
A name of the Amazon CloudWatch metric. The name can contain only the characters: A-Z, a-z, 0-9, - (hyphen), and
_ (underscore). The name can be from one to 128 characters long. It can't contain whitespace or metric names
reserved for WAF, for example All and Default_Action.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String id
A unique identifier for the WebACL. This ID is returned in the responses to create and list
commands. You use this ID to do things like get, update, and delete a WebACL.
String aRN
The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.
DefaultAction defaultAction
The action to perform if none of the Rules contained in the WebACL match.
String description
A description of the web ACL that helps with identification.
List<E> rules
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
Long capacity
The web ACL capacity units (WCUs) currently being used by this web ACL.
WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.
List<E> preProcessFirewallManagerRuleGroups
The first set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized after these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
List<E> postProcessFirewallManagerRuleGroups
The last set of rules for WAF to process in the web ACL. This is defined in an Firewall Manager WAF policy and contains only rule group references. You can't alter these. Any rules and rule groups that you define for the web ACL are prioritized before these.
In the Firewall Manager WAF policy, the Firewall Manager administrator can define a set of rule groups to run first in the web ACL and a set of rule groups to run last. Within each set, the administrator prioritizes the rule groups, to determine their relative processing order.
Boolean managedByFirewallManager
Indicates whether this web ACL is managed by Firewall Manager. If true, then only Firewall Manager can delete the web ACL or any Firewall Manager rule groups in the web ACL.
String labelNamespace
The label namespace prefix for this web ACL. All labels added by rules in this web ACL have this prefix.
The syntax for the label namespace prefix for a web ACL is the following:
awswaf:<account ID>:webacl:<web ACL name>:
When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
Map<K,V> customResponseBodies
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
CaptchaConfig captchaConfig
Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own
CaptchaConfig settings. If you don't specify this, WAF uses its default settings for
CaptchaConfig.
String name
The name of the web ACL. You cannot change the name of a web ACL after you create it.
String id
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
String description
A description of the web ACL that helps with identification.
String lockToken
A token used for optimistic locking. WAF returns a token to your get and list requests,
to mark the state of the entity at the time of the request. To make changes to the entity associated with the
token, you provide the token to operations like update and delete. WAF uses the token
to ensure that no changes have been made to the entity since you last retrieved it. If a change has been made,
the update fails with a WAFOptimisticLockException. If this happens, perform another
get, and use the new token returned by that operation.
String aRN
The Amazon Resource Name (ARN) of the entity.
FieldToMatch fieldToMatch
The part of the web request that you want WAF to inspect.
List<E> textTransformations
Text transformations eliminate some of the unusual formatting that attackers use in web requests in an effort to
bypass detection. If you specify one or more transformations in a rule statement, WAF performs all
transformations on the content of the request component identified by FieldToMatch, starting from
the lowest priority setting, before inspecting the content for a match.
Copyright © 2022. All rights reserved.