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 stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
ByteBuffer searchString
A string value that you want AWS WAF to search for. AWS 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 areas that you specify for inspection in FieldToMatch:
Method: The HTTP method that you want AWS WAF to search for. This indicates the type of operation
specified in the request.
UriPath: The value that you want AWS 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 AWS WAF API
Specify a base64-encoded version of the value. The maximum length of the value before you base64-encode it is 50 bytes.
For example, suppose the value of Type is HEADER and the value of Data is
User-Agent. If you want to search the User-Agent header for the value
BadBot, you base64-encode BadBot using MIME base64-encoding and include the resulting
value, QmFkQm90, in the value of SearchString.
If you're using the AWS CLI or one of the AWS SDKs
The value that you want AWS WAF to search for. The SDK automatically base64 encodes the value.
FieldToMatch fieldToMatch
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
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, AWS WAF performs all
transformations on the content identified by FieldToMatch, starting from the lowest priority
setting, before inspecting the content for a match.
String positionalConstraint
The area within the portion of a web request that you want AWS 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.
String scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the IP set. You cannot change the description of an IP set after you create it.
String iPAddressVersion
Specify IPV4 or IPV6.
List<E> addresses
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address
1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses
1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
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
A friendly name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the set. You cannot change the description of a set after you create it.
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
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS 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 friendly description of the rule group. You cannot change the description of a rule group after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS 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.
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
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS 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.
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.
BlockAction block
Specifies that AWS WAF should block requests by default.
AllowAction allow
Specifies that AWS WAF should allow requests by default.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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 name
A friendly name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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 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 stage:
arn:aws:apigateway:region::/restapis/api-id/stages/stage-name
String name
The name of the rule to exclude.
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.
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.
This is used only to indicate the web request component for AWS WAF to inspect, in the FieldToMatch specification.
AllQueryArguments allQueryArguments
Inspect all query arguments.
UriPath uriPath
Inspect the request URI path. This is the part of a 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, which 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.
Note that only the first 8 KB (8192 bytes) of the request body are forwarded to AWS WAF for inspection by the underlying host service. If you don't need to inspect more than 8 KB, you can guarantee that you don't allow additional bytes in by combining a statement that inspects the body of the web request, such as ByteMatchStatement or RegexPatternSetReferenceStatement, with a SizeConstraintStatement that enforces an 8 KB size limit on the body of the request. AWS WAF doesn't support inspecting the entire contents of web requests whose bodies exceed the 8 KB limit.
Method method
Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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 scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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
A friendly 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 ruleName
The name of the rate-based rule to get the keys for.
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
A friendly name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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.
RuleGroup ruleGroup
String lockToken
A token used for optimistic locking. AWS 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. AWS 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
Long maxItems
The number of requests that you want AWS WAF to return from among the first 5,000 requests that your AWS resource
received during the time range. If your resource received fewer requests than the value of MaxItems,
GetSampledRequests returns information about all of them.
List<E> sampledRequests
A complex type that contains detailed information about each of the requests in the sample.
Long populationSize
The total number of requests from which GetSampledRequests got a sample of MaxItems
requests. If PopulationSize is less than MaxItems, the sample includes every request
that your AWS resource received during the specified time range.
TimeWindow timeWindow
Usually, TimeWindow is the time range that you specified in the GetSampledRequests
request. However, if your AWS resource received more than 5,000 requests during the time range that you specified
in the request, GetSampledRequests returns the time range for the first 5,000 requests.
String resourceArn
The ARN (Amazon Resource Name) of the resource.
WebACL webACL
The Web ACL that is associated with the resource. If there is no associated resource, AWS WAF returns a null Web ACL.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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. AWS 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. AWS 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 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.
String name
A friendly 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 friendly description of the IP set. You cannot change the description of an IP set after you create it.
String iPAddressVersion
Specify IPV4 or IPV6.
List<E> addresses
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address
1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses
1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
String name
A friendly 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 friendly description of the IP set. You cannot change the description of an IP set after you create it.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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 scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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, AWS 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 AWS WAF to return for this request. If more objects are available, in
the response, AWS 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, AWS 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 Amazon Kinesis Data Firehose Amazon Resource Name (ARNs) that you want to associate with the 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 cookie field, the
cookie field in the firehose will be xxx.
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.
List<E> excludedRules
The rules whose actions are set to COUNT by the web ACL, regardless of the action that is set on the
rule. This effectively excludes the rule from acting on web requests.
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 description
The description of the managed rule group, provided by AWS Managed Rules or the AWS Marketplace seller who manages it.
Statement statement
The statement to negate. You can use any statement that can be nested.
CountAction count
Override the rule action setting to count.
NoneAction none
Don't override the rule action setting.
LoggingConfiguration loggingConfiguration
LoggingConfiguration loggingConfiguration
Long limit
The limit on requests per 5-minute period for a single originating IP address. If the statement includes a
ScopDownStatement, this limit is applied only to the requests that match the statement.
String aggregateKeyType
Setting that indicates how to aggregate the request counts. Currently, you must set this to IP. The
request counts are aggregated on IP addresses.
Statement scopeDownStatement
An optional nested statement that narrows the scope of the rate-based statement to matching web requests. This can be any nestable statement, and you can nest statements at any level below this scope-down statement.
String regexString
The string representing the regular expression.
String name
A friendly 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 friendly description of the set. You cannot change the description of a set after you create it.
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 a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
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, AWS WAF performs all
transformations on the content identified by FieldToMatch, starting from the lowest priority
setting, before inspecting the content for a match.
String name
A friendly 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 friendly description of the set. You cannot change the description of a set after you create it.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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
A friendly 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, AWS WAF evaluates each request against
the Rules in order based on the value of Priority. AWS WAF processes rules with lower
priority first. The priorities don't need to be consecutive, but they must all be different.
Statement statement
The AWS WAF processing statement for the rule, for example ByteMatchStatement or SizeConstraintStatement.
RuleAction action
The action that AWS WAF should take on a web request when it matches the rule's statement. Settings at the web ACL level can override the rule action setting.
OverrideAction overrideAction
The action to use to override the rule's Action setting. You can use no override action, in which
case the rule action is in effect, or count action, in which case, if the rule matches a web request, it only
counts the match.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
BlockAction block
Instructs AWS WAF to block the web request.
AllowAction allow
Instructs AWS WAF to allow the web request.
CountAction count
Instructs AWS WAF to count the web request and allow it.
String name
A friendly 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, AWS WAF enforces this limit. You can check the capacity for a set of rules using CheckCapacity.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS 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 friendly description of the rule group. You cannot change the description of a rule group after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String name
A friendly 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 friendly description of the rule group. You cannot change the description of a rule group after you create it.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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
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 AWS WAF received the request from your AWS resource, in Unix time format (in seconds).
String action
The action for the Rule that the request matched: ALLOW, BLOCK, or
COUNT.
String 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, the format is <rule name>.
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 a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
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, AWS WAF performs all
transformations on the content identified by FieldToMatch, starting from the lowest priority
setting, before inspecting the content for a match.
FieldToMatch fieldToMatch
The part of a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
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, AWS WAF performs all
transformations on the content identified by FieldToMatch, starting from the lowest priority
setting, before inspecting the content for a match.
ByteMatchStatement byteMatchStatement
A rule statement that defines a string match search for AWS WAF to apply to web requests. The byte match statement provides the bytes to search for, the location in requests that you want AWS WAF to search, and other settings. The bytes to search for are typically a string that corresponds with ASCII characters. In the AWS WAF console and the developer guide, this is refered to as a string match statement.
SqliMatchStatement sqliMatchStatement
Attackers sometimes insert malicious SQL code into web requests in an effort to extract data from your database. To allow or block web requests that appear to contain malicious SQL code, create one or more SQL injection match conditions. An SQL injection match condition identifies the part of web requests, such as the URI or the query string, that you want AWS WAF to inspect. Later in the process, when you create a web ACL, you specify whether to allow or block requests that appear to contain malicious SQL code.
XssMatchStatement xssMatchStatement
A rule statement that defines a cross-site scripting (XSS) match search for AWS WAF to apply to web requests. XSS attacks are those where the attacker uses vulnerabilities in a benign website as a vehicle to inject malicious client-site scripts into other legitimate web browsers. The XSS match statement provides the location in requests that you want AWS WAF to search and text transformations to use on the search area before AWS WAF searches for character sequences that are likely to be malicious strings.
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 AWS WAF to inspect the request body, AWS WAF inspects only the first 8192 bytes (8 KB). If the request body for your web requests never exceeds 8192 bytes, you can create a size constraint condition and 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. It can only be referenced as a top-level statement within
a rule.
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, AWS 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, AWS 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.
When the rule action triggers, AWS 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 both of the conditions in the statements are counted. If the count exceeds 1,000 requests per five minutes, the rule action triggers. Requests that do not meet both conditions are not counted towards the rate limit and are not affected by this rule.
You cannot nest a RateBasedStatement, for example for use inside a NotStatement or
OrStatement. It can only be referenced as a top-level statement within a rule.
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 can't 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.
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. AWS 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:
CMD_LINE
When you're concerned that attackers are injecting an operating system command line command and using unusual formatting to disguise some or all of the command, use this option to perform the following transformations:
Delete the following characters: \ " ' ^
Delete spaces before the following characters: / (
Replace the following characters with a space: , ;
Replace multiple spaces with one space
Convert uppercase letters (A-Z) to lowercase (a-z)
COMPRESS_WHITE_SPACE
Use this option to replace the following characters with a space character (decimal 32):
\f, formfeed, decimal 12
\t, tab, decimal 9
\n, newline, decimal 10
\r, carriage return, decimal 13
\v, vertical tab, decimal 11
non-breaking space, decimal 160
COMPRESS_WHITE_SPACE also replaces multiple spaces with one space.
HTML_ENTITY_DECODE
Use this option to replace HTML-encoded characters with unencoded characters. HTML_ENTITY_DECODE
performs the following operations:
Replaces (ampersand)quot; with "
Replaces (ampersand)nbsp; with a non-breaking space, decimal 160
Replaces (ampersand)lt; with a "less than" symbol
Replaces (ampersand)gt; with >
Replaces characters that are represented in hexadecimal format, (ampersand)#xhhhh;, with the
corresponding characters
Replaces characters that are represented in decimal format, (ampersand)#nnnn;, with the
corresponding characters
LOWERCASE
Use this option to convert uppercase letters (A-Z) to lowercase (a-z).
URL_DECODE
Use this option to decode a URL-encoded value.
NONE
Specify NONE if you don't want any text transformations.
Date startTime
The beginning of the time range from which you want GetSampledRequests to return a sample of the
requests that your AWS resource received. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
Date endTime
The end of the time range from which you want GetSampledRequests to return a sample of the requests
that your AWS resource received. Specify the date and time in the following format:
"2016-09-27T14:50Z". You can specify any time range in the previous three hours.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the IP set. You cannot change the description of an IP set after you create it.
List<E> addresses
Contains an array of strings that specify one or more IP addresses or blocks of IP addresses in Classless Inter-Domain Routing (CIDR) notation. AWS WAF supports all address ranges for IP versions IPv4 and IPv6.
Examples:
To configure AWS WAF to allow, block, or count requests that originated from the IP address 192.0.2.44, specify
192.0.2.44/32.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses from 192.0.2.0 to
192.0.2.255, specify 192.0.2.0/24.
To configure AWS WAF to allow, block, or count requests that originated from the IP address
1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
To configure AWS WAF to allow, block, or count requests that originated from IP addresses
1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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. AWS WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
A friendly name of the set. You cannot change the name after you create the set.
String scope
Specifies whether this is for an AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the set. You cannot change the description of a set after you create it.
List<E> regularExpressionList
String lockToken
A token used for optimistic locking. AWS 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. AWS 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. AWS WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the rule group. You cannot change the description of a rule group after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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. AWS WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
String name
A friendly 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 AWS CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB) or an API Gateway stage.
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 friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS WAF handles them.
VisibilityConfig visibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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. AWS WAF returns this token to your update requests. You use
NextLockToken in the same manner as you use LockToken.
Boolean sampledRequestsEnabled
A boolean indicating whether AWS WAF should store a sampling of the web requests that match the rules. You can view the sampled requests through the AWS WAF console.
Boolean cloudWatchMetricsEnabled
A boolean indicating whether the associated resource sends metrics to CloudWatch. For the list of available metrics, see AWS WAF Metrics.
String metricName
A friendly name of the CloudWatch metric. The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
length from one to 128 characters. It can't contain whitespace or metric names reserved for AWS WAF, for example
"All" and "Default_Action." You can't change a MetricName after you create a
VisibilityConfig.
String name
A friendly 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 friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
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 AWS WAF uses to identify matching web requests, and parameters that govern how AWS 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.
AWS WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. AWS 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 name
A friendly 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 friendly description of the Web ACL. You cannot change the description of a Web ACL after you create it.
String lockToken
A token used for optimistic locking. AWS 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. AWS 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 a web request that you want AWS WAF to inspect. For more information, see FieldToMatch.
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, AWS WAF performs all
transformations on the content identified by FieldToMatch, starting from the lowest priority
setting, before inspecting the content for a match.
Copyright © 2020. All rights reserved.