Used for the maximum size limit of the LRU cache storing endpoints data
for endpoint discovery enabled operations. Defaults to 1000. See Plugins::EndpointDiscovery for more details.

:endpoint_cache_max_threads(Integer)
—

Used for the maximum threads in use for polling endpoints to be cached,
defaults to 10. See Plugins::EndpointDiscovery for more details.

:endpoint_cache_poll_interval(Integer)
—

When :endpoint_discovery and :active_endpoint_cache is enabled,
Use this option to config the time interval in seconds for making
requests fetching endpoints information. Defaults to 60 sec. See Plugins::EndpointDiscovery for more details.

:endpoint_discovery(Boolean)
—

When
set to true, endpoint discovery will be enabled for
operations when available. Defaults to false. See Plugins::EndpointDiscovery for more details.

The AWS region to connect to. The region is used to construct
the client endpoint. Defaults to ENV['AWS_REGION'].
Also checks AMAZON_REGION and AWS_DEFAULT_REGION. See Plugins::RegionalEndpoint for more details.

:retry_limit(Integer)
— default:
3
—

The maximum number of times to retry failed requests. Only
~ 500 level server errors and certain ~ 400 level client errors
are retried. Generally, these are throttling errors, data
checksum errors, networking errors, timeout errors and auth
errors from expired credentials. See Plugins::RetryErrors for more details.

Causes the client to return stubbed responses. By default
fake responses are generated and returned. You can specify
the response data to return or errors to raise by calling
ClientStubs#stub_responses. See ClientStubs for more information.

Please note When response stubbing is enabled, no HTTP
requests are made, and retries are disabled. See Plugins::StubResponses for more details.

:validate_params(Boolean)
— default:
true
—

When true, request parameters are validated before
sending the request. See Plugins::ParamValidator for more details.

Instance Method Details

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a ByteMatchSet. You then use UpdateByteMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a ByteMatchSet that matches any requests with User-Agent headers that contain the string BadBot. You can then configure AWS WAF to reject those requests.

To create and configure a ByteMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateByteMatchSet request.

Submit a CreateByteMatchSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an GeoMatchSet, which you use to specify which web requests you want to allow or block based on the country that the requests originate from. For example, if you're receiving a lot of requests from one or more countries and you want to block the requests, you can create an GeoMatchSet that contains those countries and then configure AWS WAF to block the requests.

To create and configure a GeoMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateGeoMatchSet request.

Submit a CreateGeoMatchSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateGeoMatchSet request.

Submit an UpdateGeoMatchSetSet request to specify the countries that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an IPSet, which you use to specify which web requests that you want to allow or block based on the IP addresses that the requests originate from. For example, if you're receiving a lot of requests from one or more individual IP addresses or one or more ranges of IP addresses and you want to block the requests, you can create an IPSet that contains those IP addresses and then configure AWS WAF to block the requests.

To create and configure an IPSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateIPSet request.

Submit a CreateIPSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateIPSet request.

Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To create an IP set

# The following example creates an IP match set named MyIPSetFriendlyName.
resp=client.create_ip_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",name:"MyIPSetFriendlyName",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",ip_set:{ip_set_descriptors:[{type:"IPV4",value:"192.0.2.44/32",},],ip_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",name:"MyIPSetFriendlyName",},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RateBasedRule. The RateBasedRule contains a RateLimit, which specifies the maximum number of requests that AWS WAF allows from a specified IP address in a five-minute period. The RateBasedRule also contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to count or block if these requests exceed the RateLimit.

If you add more than one predicate to a RateBasedRule, a request not only must exceed the RateLimit, but it also must match all the conditions to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

An IPSet that matches the IP address 192.0.2.44/32

A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 1,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that meet the conditions in the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions must be received at a rate of more than 1,000 requests every five minutes. If both conditions are met and the rate is exceeded, AWS WAF blocks the requests. If the rate drops below 1,000 for a five-minute period, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

A ByteMatchSet with FieldToMatch of URI

A PositionalConstraint of STARTS_WITH

A TargetString of login

Further, you specify a RateLimit of 1,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

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

:metric_name(required, String)
—

A friendly name or description for the metrics for this RateBasedRule.
The name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
maximum length 128 and minimum length one. It can\'t contain whitespace
or metric names reserved for AWS WAF, including \"All\" and
\"Default_Action.\" You can\'t change the name of the metric after you
create the RateBasedRule.

:rate_key(required, String)
—

The field that AWS WAF uses to determine if requests are likely arriving
from a single source and thus subject to rate monitoring. The only valid
value for RateKey is IP. IP indicates that requests that arrive
from the same IP address are subject to the RateLimit that is
specified in the RateBasedRule.

:rate_limit(required, Integer)
—

The maximum number of requests, which have an identical value in the
field that is specified by RateKey, allowed in a five-minute period.
If the number of requests exceeds the RateLimit and the other
predicates specified in the rule are also met, AWS WAF triggers the
action that is specified for this rule.

:change_token(required, String)
—

The ChangeToken that you used to submit the CreateRateBasedRule
request. You can also use this value to query the status of the request.
For more information, see GetChangeTokenStatus.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RegexMatchSet. You then use UpdateRegexMatchSet to identify the part of a web request that you want AWS WAF to inspect, such as the values of the User-Agent header or the query string. For example, you can create a RegexMatchSet that contains a RegexMatchTuple that looks for any requests with User-Agent headers that match a RegexPatternSet with pattern B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexMatchSet request.

Submit a CreateRegexMatchSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value, using a RegexPatternSet, that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a RegexPatternSet. You then use UpdateRegexPatternSet to specify the regular expression (regex) pattern that you want AWS WAF to search for, such as B[a@]dB[o0]t. You can then configure AWS WAF to reject those requests.

To create and configure a RegexPatternSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRegexPatternSet request.

Submit a CreateRegexPatternSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexPatternSet request.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a Rule, which contains the IPSet objects, ByteMatchSet objects, and other predicates that identify the requests that you want to block. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed or blocked. For example, suppose that you add the following to a Rule:

An IPSet that matches the IP address 192.0.2.44/32

A ByteMatchSet that matches BadBot in the User-Agent header

You then add the Rule to a WebACL and specify that you want to blocks requests that satisfy the Rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateRule request.

Submit a CreateRule request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRule request.

Submit an UpdateRule request to specify the predicates that you want to include in the Rule.

Create and update a WebACL that contains the Rule. For more information, see CreateWebACL.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To create a rule

# The following example creates a rule named WAFByteHeaderRule.
resp=client.create_rule({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",metric_name:"WAFByteHeaderRule",name:"WAFByteHeaderRule",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",rule:{metric_name:"WAFByteHeaderRule",name:"WAFByteHeaderRule",predicates:[{data_id:"MyByteMatchSetID",negated:false,type:"ByteMatch",},],rule_id:"WAFRule-1-Example",},}

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

:metric_name(required, String)
—

A friendly name or description for the metrics for this Rule. The name
can contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum
length 128 and minimum length one. It can\'t contain whitespace or
metric names reserved for AWS WAF, including \"All\" and
\"Default_Action.\" You can\'t change the name of the metric after you
create the Rule.

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

:metric_name(required, String)
—

A friendly name or description for the metrics for this RuleGroup. The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
maximum length 128 and minimum length one. It can\'t contain whitespace
or metric names reserved for AWS WAF, including \"All\" and
\"Default_Action.\" You can\'t change the name of the metric after you
create the RuleGroup.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a SizeConstraintSet. You then use UpdateSizeConstraintSet to identify the part of a web request that you want AWS WAF to check for length, such as the length of the User-Agent header or the length of the query string. For example, you can create a SizeConstraintSet that matches any requests that have a query string that is longer than 100 bytes. You can then configure AWS WAF to reject those requests.

To create and configure a SizeConstraintSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSizeConstraintSet request.

Submit a CreateSizeConstraintSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To create a size constraint

# The following example creates size constraint set named MySampleSizeConstraintSet.
resp=client.create_size_constraint_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",name:"MySampleSizeConstraintSet",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",size_constraint_set:{name:"MySampleSizeConstraintSet",size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",size_constraints:[{comparison_operator:"GT",field_to_match:{type:"QUERY_STRING",},size:0,text_transformation:"NONE",},],},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a SqlInjectionMatchSet, which you use to allow, block, or count requests that contain snippets of SQL code in a specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure a SqlInjectionMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateSqlInjectionMatchSet request.

Submit a CreateSqlInjectionMatchSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSqlInjectionMatchSet request.

Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests in which you want to allow, block, or count malicious SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To create a SQL injection match set

# The following example creates a SQL injection match set named MySQLInjectionMatchSet.
resp=client.create_sql_injection_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",name:"MySQLInjectionMatchSet",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",sql_injection_match_set:{name:"MySQLInjectionMatchSet",sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",sql_injection_match_tuples:[{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},],},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates a WebACL, which contains the Rules that identify the CloudFront web requests that you want to allow, block, or count. AWS WAF evaluates Rules in order based on the value of Priority for each Rule.

You also specify a default action, either ALLOW or BLOCK. If a web request doesn't match any of the Rules in a WebACL, AWS WAF responds to the request with the default action.

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

:metric_name(required, String)
—

A friendly name or description for the metrics for this WebACL.The
name can contain only alphanumeric characters (A-Z, a-z, 0-9), with
maximum length 128 and minimum length one. It can\'t contain whitespace
or metric names reserved for AWS WAF, including \"All\" and
\"Default_Action.\" You can\'t change MetricName after you create the
WebACL.

Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket. Then, in CloudFormation, you create a stack from the template, to create the web ACL and its resources in AWS WAFV2. Use this to migrate your AWS WAF Classic web ACL to the latest version of AWS WAF.

The UUID of the WAF Classic web ACL that you want to migrate to WAF v2.

:s3_bucket_name(required, String)
—

The name of the Amazon S3 bucket to store the CloudFormation template
in. The S3 bucket must be configured as follows for the migration:

The bucket name must start with aws-waf-migration-. For example,
aws-waf-migration-my-web-acl.

The bucket must be in the Region where you are deploying the template.
For example, for a web ACL in us-west-2, you must use an Amazon S3
bucket in us-west-2 and you must deploy the template stack to
us-west-2.

The bucket policies must permit the migration process to write data.
For listings of the bucket policies, see the Examples section.

:ignore_unsupported_type(required, Boolean)
—

Indicates whether to exclude entities that can\'t be migrated or to stop
the migration. Set this to true to ignore unsupported entities in the
web ACL during the migration. Otherwise, if AWS WAF encounters
unsupported entities, it stops the process and throws an exception.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Creates an XssMatchSet, which you use to allow, block, or count requests that contain cross-site scripting attacks in the specified part of web requests. AWS WAF searches for character sequences that are likely to be malicious strings.

To create and configure an XssMatchSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a CreateXssMatchSet request.

Submit a CreateXssMatchSet request.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateXssMatchSet request.

Submit an UpdateXssMatchSet request to specify the parts of web requests in which you want to allow, block, or count cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To create an XSS match set

# The following example creates an XSS match set named MySampleXssMatchSet.
resp=client.create_xss_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",name:"MySampleXssMatchSet",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",xss_match_set:{name:"MySampleXssMatchSet",xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",xss_match_tuples:[{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},],},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a ByteMatchSet. You can't delete a ByteMatchSet if it's still used in any Rules or if it still includes any ByteMatchTuple objects (any filters).

If you just want to remove a ByteMatchSet from a Rule, use UpdateRule.

To permanently delete a ByteMatchSet, perform the following steps:

Update the ByteMatchSet to remove filters, if any. For more information, see UpdateByteMatchSet.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteByteMatchSet request.

Submit a DeleteByteMatchSet request.

Examples:

Example: To delete a byte match set

# The following example deletes a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.delete_byte_match_set({byte_match_set_id:"exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

To permanently delete an IPSet from AWS WAF, perform the following steps:

Update the IPSet to remove IP address ranges, if any. For more information, see UpdateIPSet.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteIPSet request.

Submit a DeleteIPSet request.

Examples:

Example: To delete an IP set

# The following example deletes an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.delete_ip_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",ip_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

To permanently delete a Rule from AWS WAF, perform the following steps:

Update the Rule to remove predicates, if any. For more information, see UpdateRule.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

Submit a DeleteRule request.

Examples:

Example: To delete a rule

# The following example deletes a rule with the ID WAFRule-1-Example.
resp=client.delete_rule({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",rule_id:"WAFRule-1-Example",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSizeConstraintSet request.

Submit a DeleteSizeConstraintSet request.

Examples:

Example: To delete a size constraint set

# The following example deletes a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.delete_size_constraint_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteSqlInjectionMatchSet request.

Submit a DeleteSqlInjectionMatchSet request.

Examples:

Example: To delete a SQL injection match set

# The following example deletes a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.delete_sql_injection_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes a WebACL. You can't delete a WebACL if it still contains any Rules.

To delete a WebACL, perform the following steps:

Update the WebACL to remove Rules, if any. For more information, see UpdateWebACL.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteWebACL request.

Submit a DeleteWebACL request.

Examples:

Example: To delete a web ACL

# The following example deletes a web ACL with the ID example-46da-4444-5555-example.
resp=client.delete_web_acl({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",web_acl_id:"example-46da-4444-5555-example",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Permanently deletes an XssMatchSet. You can't delete an XssMatchSet if it's still used in any Rules or if it still contains any XssMatchTuple objects.

If you just want to remove an XssMatchSet from a Rule, use UpdateRule.

To permanently delete an XssMatchSet from AWS WAF, perform the following steps:

Update the XssMatchSet to remove filters, if any. For more information, see UpdateXssMatchSet.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteXssMatchSet request.

Submit a DeleteXssMatchSet request.

Examples:

Example: To delete an XSS match set

# The following example deletes an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.delete_xss_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

# The following example returns the details of a byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_byte_match_set({byte_match_set_id:"exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{byte_match_set:{byte_match_set_id:"exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",byte_match_tuples:[{field_to_match:{data:"referer",type:"HEADER",},positional_constraint:"CONTAINS",target_string:"badrefer1",text_transformation:"NONE",},],name:"ByteMatchNameExample",},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

When you want to create, update, or delete AWS WAF objects, get a change token and include the change token in the create, update, or delete request. Change tokens ensure that your application doesn't submit conflicting requests to AWS WAF.

Each create, update, or delete request must use a unique change token. If your application submits a GetChangeToken request and then submits a second GetChangeToken request before submitting a create, update, or delete request, the second GetChangeToken request returns the same value as the first GetChangeToken request.

When you use a change token in a create, update, or delete request, the status of the change token changes to PENDING, which indicates that AWS WAF is propagating the change to all AWS WAF servers. Use GetChangeTokenStatus to determine the status of your change token.

Examples:

Example: To get a change token

# The following example returns a change token to use for a create, update or delete operation.
resp=client.get_change_token({})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the status of a ChangeToken that you got by calling GetChangeToken. ChangeTokenStatus is one of the following values:

PROVISIONED: You requested the change token by calling GetChangeToken, but you haven't used it yet in a call to create, update, or delete an AWS WAF object.

PENDING: AWS WAF is propagating the create, update, or delete request to all AWS WAF servers.

INSYNC: Propagation is complete.

Examples:

Example: To get the change token status

# The following example returns the status of a change token with the ID abcd12f2-46da-4fdb-b8d5-fbd4c466928f.
resp=client.get_change_token_status({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",})# resp.to_h outputs the following:
{change_token_status:"PENDING",}

# The following example returns the details of an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_ip_set({ip_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{ip_set:{ip_set_descriptors:[{type:"IPV4",value:"192.0.2.44/32",},],ip_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",name:"MyIPSetFriendlyName",},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns an array of IP addresses currently being blocked by the RateBasedRule that is specified by the RuleId. The maximum number of managed keys that will be blocked is 10,000. If more than 10,000 addresses exceed the rate limit, the 10,000 addresses with the highest rates will be blocked.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Returns the Rule that is specified by the RuleId that you included in the GetRule request.

Examples:

Example: To get a rule

# The following example returns the details of a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_rule({rule_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{rule:{metric_name:"WAFByteHeaderRule",name:"WAFByteHeaderRule",predicates:[{data_id:"MyByteMatchSetID",negated:false,type:"ByteMatch",},],rule_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",},}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Gets detailed information about a specified number of requests--a sample--that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received during a time range that you choose. You can specify a sample size of up to 500 requests, and you can specify any time range in the previous three hours.

GetSampledRequests returns a time range, which is usually the time range that you specified. However, if your resource (such as a CloudFront distribution) received 5,000 requests before the specified time range elapsed, GetSampledRequests returns an updated time range. This new time range indicates the actual period during which AWS WAF selected the requests in the sample.

Examples:

Example: To get a sampled requests

# The following example returns detailed information about 100 requests --a sample-- that AWS WAF randomly selects from among the first 5,000 requests that your AWS resource received between the time period 2016-09-27T15:50Z to 2016-09-27T15:50Z.
resp=client.get_sampled_requests({max_items:100,rule_id:"WAFRule-1-Example",time_window:{end_time:Time.parse("2016-09-27T15:50Z"),start_time:Time.parse("2016-09-27T15:50Z"),},web_acl_id:"createwebacl-1472061481310",})# resp.to_h outputs the following:
{population_size:50,sampled_requests:[{action:"BLOCK",request:{client_ip:"192.0.2.44",country:"US",http_version:"HTTP/1.1",headers:[{name:"User-Agent",value:"BadBot ",},],method:"HEAD",},timestamp:Time.parse("2016-09-27T14:55Z"),weight:1,},],time_window:{end_time:Time.parse("2016-09-27T15:50Z"),start_time:Time.parse("2016-09-27T14:50Z"),},}

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.

:max_items(required, Integer)
—

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.

# The following example returns the details of a size constraint match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_size_constraint_set({size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{size_constraint_set:{name:"MySampleSizeConstraintSet",size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",size_constraints:[{comparison_operator:"GT",field_to_match:{type:"QUERY_STRING",},size:0,text_transformation:"NONE",},],},}

# The following example returns the details of a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_sql_injection_match_set({sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{sql_injection_match_set:{name:"MySQLInjectionMatchSet",sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",sql_injection_match_tuples:[{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},],},}

# The following example returns the details of a web ACL with the ID createwebacl-1472061481310.
resp=client.get_web_acl({web_acl_id:"createwebacl-1472061481310",})# resp.to_h outputs the following:
{web_acl:{default_action:{type:"ALLOW",},metric_name:"CreateExample",name:"CreateExample",rules:[{action:{type:"ALLOW",},priority:1,rule_id:"WAFRule-1-Example",},],web_acl_id:"createwebacl-1472061481310",},}

# The following example returns the details of an XSS match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.get_xss_match_set({xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{xss_match_set:{name:"MySampleXssMatchSet",xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",xss_match_tuples:[{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},],},}

If you specify a value for Limit and you have more ActivatedRules
than the value of Limit, AWS WAF returns a NextMarker value in the
response that allows you to list another group of ActivatedRules. For
the second and subsequent ListActivatedRulesInRuleGroup requests,
specify the value of NextMarker from the previous response to get
information about another batch of ActivatedRules.

:limit(Integer)
—

Specifies the number of ActivatedRules that you want AWS WAF to return
for this request. If you have more ActivatedRules than the number that
you specify for Limit, the response includes a NextMarker value that
you can use to get another batch of ActivatedRules.

If you specify a value for Limit and you have more ByteMatchSets
than the value of Limit, AWS WAF returns a NextMarker value in the
response that allows you to list another group of ByteMatchSets. For
the second and subsequent ListByteMatchSets requests, specify the
value of NextMarker from the previous response to get information
about another batch of ByteMatchSets.

:limit(Integer)
—

Specifies the number of ByteMatchSet objects that you want AWS WAF to
return for this request. If you have more ByteMatchSets objects than
the number you specify for Limit, the response includes a NextMarker
value that you can use to get another batch of ByteMatchSet objects.

If you specify a value for Limit and you have more GeoMatchSets than
the value of Limit, AWS WAF returns a NextMarker value in the
response that allows you to list another group of GeoMatchSet objects.
For the second and subsequent ListGeoMatchSets requests, specify the
value of NextMarker from the previous response to get information
about another batch of GeoMatchSet objects.

:limit(Integer)
—

Specifies the number of GeoMatchSet objects that you want AWS WAF to
return for this request. If you have more GeoMatchSet objects than the
number you specify for Limit, the response includes a NextMarker
value that you can use to get another batch of GeoMatchSet objects.

# The following example returns an array of up to 100 IP match sets.
resp=client.list_ip_sets({limit:100,})# resp.to_h outputs the following:
{ip_sets:[{ip_set_id:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",name:"MyIPSetFriendlyName",},],}

AWS WAF returns a NextMarker value in the response that allows you to
list another group of IPSets. For the second and subsequent
ListIPSets requests, specify the value of NextMarker from the
previous response to get information about another batch of IPSets.

:limit(Integer)
—

Specifies the number of IPSet objects that you want AWS WAF to return
for this request. If you have more IPSet objects than the number you
specify for Limit, the response includes a NextMarker value that you
can use to get another batch of IPSet objects.

If you specify a value for Limit and you have more
LoggingConfigurations than the value of Limit, AWS WAF returns a
NextMarker value in the response that allows you to list another group
of LoggingConfigurations. For the second and subsequent
ListLoggingConfigurations requests, specify the value of NextMarker
from the previous response to get information about another batch of
ListLoggingConfigurations.

:limit(Integer)
—

Specifies the number of LoggingConfigurations that you want AWS WAF to
return for this request. If you have more LoggingConfigurations than
the number that you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of
LoggingConfigurations.

If you specify a value for Limit and you have more Rules than the
value of Limit, AWS WAF returns a NextMarker value in the response
that allows you to list another group of Rules. For the second and
subsequent ListRateBasedRules requests, specify the value of
NextMarker from the previous response to get information about another
batch of Rules.

:limit(Integer)
—

Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for
Limit, the response includes a NextMarker value that you can use to
get another batch of Rules.

If you specify a value for Limit and you have more RegexMatchSet
objects than the value of Limit, AWS WAF returns a NextMarker value
in the response that allows you to list another group of
ByteMatchSets. For the second and subsequent ListRegexMatchSets
requests, specify the value of NextMarker from the previous response
to get information about another batch of RegexMatchSet objects.

:limit(Integer)
—

Specifies the number of RegexMatchSet objects that you want AWS WAF to
return for this request. If you have more RegexMatchSet objects than
the number you specify for Limit, the response includes a NextMarker
value that you can use to get another batch of RegexMatchSet objects.

If you specify a value for Limit and you have more RegexPatternSet
objects than the value of Limit, AWS WAF returns a NextMarker value
in the response that allows you to list another group of
RegexPatternSet objects. For the second and subsequent
ListRegexPatternSets requests, specify the value of NextMarker from
the previous response to get information about another batch of
RegexPatternSet objects.

:limit(Integer)
—

Specifies the number of RegexPatternSet objects that you want AWS WAF
to return for this request. If you have more RegexPatternSet objects
than the number you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of
RegexPatternSet objects.

If you specify a value for Limit and you have more RuleGroups than
the value of Limit, AWS WAF returns a NextMarker value in the
response that allows you to list another group of RuleGroups. For the
second and subsequent ListRuleGroups requests, specify the value of
NextMarker from the previous response to get information about another
batch of RuleGroups.

:limit(Integer)
—

Specifies the number of RuleGroups that you want AWS WAF to return for
this request. If you have more RuleGroups than the number that you
specify for Limit, the response includes a NextMarker value that you
can use to get another batch of RuleGroups.

If you specify a value for Limit and you have more Rules than the
value of Limit, AWS WAF returns a NextMarker value in the response
that allows you to list another group of Rules. For the second and
subsequent ListRules requests, specify the value of NextMarker from
the previous response to get information about another batch of Rules.

:limit(Integer)
—

Specifies the number of Rules that you want AWS WAF to return for this
request. If you have more Rules than the number that you specify for
Limit, the response includes a NextMarker value that you can use to
get another batch of Rules.

# The following example returns an array of up to 100 size contraint match sets.
resp=client.list_size_constraint_sets({limit:100,})# resp.to_h outputs the following:
{size_constraint_sets:[{name:"MySampleSizeConstraintSet",size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",},],}

If you specify a value for Limit and you have more
SizeConstraintSets than the value of Limit, AWS WAF returns a
NextMarker value in the response that allows you to list another group
of SizeConstraintSets. For the second and subsequent
ListSizeConstraintSets requests, specify the value of NextMarker
from the previous response to get information about another batch of
SizeConstraintSets.

:limit(Integer)
—

Specifies the number of SizeConstraintSet objects that you want AWS
WAF to return for this request. If you have more SizeConstraintSets
objects than the number you specify for Limit, the response includes a
NextMarker value that you can use to get another batch of
SizeConstraintSet objects.

# The following example returns an array of up to 100 SQL injection match sets.
resp=client.list_sql_injection_match_sets({limit:100,})# resp.to_h outputs the following:
{sql_injection_match_sets:[{name:"MySQLInjectionMatchSet",sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",},],}

If you specify a value for Limit and you have more
SqlInjectionMatchSet objects than the value of Limit, AWS WAF
returns a NextMarker value in the response that allows you to list
another group of SqlInjectionMatchSets. For the second and subsequent
ListSqlInjectionMatchSets requests, specify the value of NextMarker
from the previous response to get information about another batch of
SqlInjectionMatchSets.

:limit(Integer)
—

Specifies the number of SqlInjectionMatchSet objects that you
want AWS WAF to return for this request. If you have more
SqlInjectionMatchSet objects than the number you specify for Limit,
the response includes a NextMarker value that you can use to get
another batch of Rules.

If you specify a value for Limit and you have more
ByteMatchSetssubscribed rule groups than the value of Limit, AWS WAF
returns a NextMarker value in the response that allows you to list
another group of subscribed rule groups. For the second and subsequent
ListSubscribedRuleGroupsRequest requests, specify the value of
NextMarker from the previous response to get information about another
batch of subscribed rule groups.

:limit(Integer)
—

Specifies the number of subscribed rule groups that you want AWS WAF to
return for this request. If you have more objects than the number you
specify for Limit, the response includes a NextMarker value that you
can use to get another batch of objects.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Retrieves the tags associated with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

# The following example returns an array of up to 100 web ACLs.
resp=client.list_web_acls({limit:100,})# resp.to_h outputs the following:
{web_acls:[{name:"WebACLexample",web_acl_id:"webacl-1472061481310",},],}

If you specify a value for Limit and you have more WebACL objects
than the number that you specify for Limit, AWS WAF returns a
NextMarker value in the response that allows you to list another group
of WebACL objects. For the second and subsequent ListWebACLs
requests, specify the value of NextMarker from the previous response
to get information about another batch of WebACL objects.

:limit(Integer)
—

Specifies the number of WebACL objects that you want AWS WAF to return
for this request. If you have more WebACL objects than the number that
you specify for Limit, the response includes a NextMarker value that
you can use to get another batch of WebACL objects.

# The following example returns an array of up to 100 XSS match sets.
resp=client.list_xss_match_sets({limit:100,})# resp.to_h outputs the following:
{xss_match_sets:[{name:"MySampleXssMatchSet",xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",},],}

If you specify a value for Limit and you have more XssMatchSet
objects than the value of Limit, AWS WAF returns a NextMarker value
in the response that allows you to list another group of XssMatchSets.
For the second and subsequent ListXssMatchSets requests, specify the
value of NextMarker from the previous response to get information
about another batch of XssMatchSets.

:limit(Integer)
—

Specifies the number of XssMatchSet objects that you want AWS WAF
to return for this request. If you have more XssMatchSet objects than
the number you specify for Limit, the response includes a NextMarker
value that you can use to get another batch of Rules.

You can access information about all traffic that AWS WAF inspects using the following steps:

Create an Amazon Kinesis Data Firehose.

Create the data firehose with a PUT source and in the region that you are operating. However, if you are capturing logs for Amazon CloudFront, always create the firehose in US East (N. Virginia).

Do not create the data firehose using a Kinesis stream as your source.

Associate that firehose to your web ACL using a PutLoggingConfiguration request.

When you successfully enable logging using a PutLoggingConfiguration request, AWS WAF will create a service linked role with the necessary permissions to write logs to the Amazon Kinesis Data Firehose. For more information, see Logging Web ACL Traffic Information in the AWS WAF Developer Guide.

#tag_resource(options = {}) ⇒ Struct

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Associates tags with the specified AWS resource. Tags are key:value pairs that you can use to categorize and manage your resources, for purposes like billing. For example, you might set the tag key to "customer" and the value to the customer name or ID. You can specify one or more tags to add to each AWS resource, up to 50 tags for a resource.

Tagging is only available through the API, SDKs, and CLI. You can't manage or view tags through the AWS WAF Classic console. You can use this action to tag the AWS resources that you manage through AWS WAF Classic: web ACLs, rule groups, and rules.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes ByteMatchTuple objects (filters) in a ByteMatchSet. For each ByteMatchTuple object, you specify the following values:

Whether to insert or delete the object from the array. If you want to change a ByteMatchSetUpdate object, you delete the existing object and add a new one.

The part of a web request that you want AWS WAF to inspect, such as a query string or the value of the User-Agent header.

The bytes (typically a string that corresponds with ASCII characters) that you want AWS WAF to look for. For more information, including how you specify the values for the AWS WAF API and the AWS CLI or SDKs, see TargetString in the ByteMatchTuple data type.

Where to look, such as at the beginning or the end of a query string.

Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.

For example, you can add a ByteMatchSetUpdate object that matches web requests in which User-Agent headers contain the string BadBot. You can then configure AWS WAF to block those requests.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateByteMatchSet request.

Submit an UpdateByteMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update a byte match set

# The following example deletes a ByteMatchTuple object (filters) in an byte match set with the ID exampleIDs3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_byte_match_set({byte_match_set_id:"exampleIDs3t-46da-4fdb-b8d5-abc321j569j5",change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",updates:[{action:"DELETE",byte_match_tuple:{field_to_match:{data:"referer",type:"HEADER",},positional_constraint:"CONTAINS",target_string:"badrefer1",text_transformation:"NONE",},},],})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

Submit an UpdateGeoMatchSet request to specify the country that you want AWS WAF to watch for.

When you update an GeoMatchSet, you specify the country that you want to add and/or the country that you want to delete. If you want to change a country, you delete the existing country and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

You use an IPSet to specify which web requests you want to allow or block based on the IP addresses that the requests originated from. For example, if you're receiving a lot of requests from one or a small number of IP addresses and you want to block the requests, you can create an IPSet that specifies those IP addresses, and then configure AWS WAF to block the requests.

Submit an UpdateIPSet request to specify the IP addresses that you want AWS WAF to watch for.

When you update an IPSet, you specify the IP addresses that you want to add and/or the IP addresses that you want to delete. If you want to change an IP address, you delete the existing IP address and add the new one.

You can insert a maximum of 1000 addresses in a single request.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update an IP set

# The following example deletes an IPSetDescriptor object in an IP match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_ip_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",ip_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",updates:[{action:"DELETE",ip_set_descriptor:{type:"IPV4",value:"192.0.2.44/32",},},],})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes Predicate objects in a rule and updates the RateLimit in the rule.

Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to block or count. The RateLimit specifies the number of requests every five minutes that triggers the rule.

If you add more than one predicate to a RateBasedRule, a request must match all the predicates and exceed the RateLimit to be counted or blocked. For example, suppose you add the following to a RateBasedRule:

An IPSet that matches the IP address 192.0.2.44/32

A ByteMatchSet that matches BadBot in the User-Agent header

Further, you specify a RateLimit of 1,000.

You then add the RateBasedRule to a WebACL and specify that you want to block requests that satisfy the rule. For a request to be blocked, it must come from the IP address 192.0.2.44 and the User-Agent header in the request must contain the value BadBot. Further, requests that match these two conditions much be received at a rate of more than 1,000 every five minutes. If the rate drops below this limit, AWS WAF no longer blocks the requests.

As a second example, suppose you want to limit requests to a particular page on your site. To do this, you could add the following to a RateBasedRule:

A ByteMatchSet with FieldToMatch of URI

A PositionalConstraint of STARTS_WITH

A TargetString of login

Further, you specify a RateLimit of 1,000.

By adding this RateBasedRule to a WebACL, you could limit requests to your login page without affecting the rest of your site.

An array of RuleUpdate objects that you want to insert into or delete
from a RateBasedRule.

:rate_limit(required, Integer)
—

The maximum number of requests, which have an identical value in the
field specified by the RateKey, allowed in a five-minute period. If
the number of requests exceeds the RateLimit and the other predicates
specified in the rule are also met, AWS WAF triggers the action that is
specified for this rule.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateRegexMatchSet request.

Submit an UpdateRegexMatchSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the identifier of the RegexPatternSet that contain the regular expression patters you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes Predicate objects in a Rule. Each Predicate object identifies a predicate, such as a ByteMatchSet or an IPSet, that specifies the web requests that you want to allow, block, or count. If you add more than one predicate to a Rule, a request must match all of the specifications to be allowed, blocked, or counted. For example, suppose that you add the following to a Rule:

A ByteMatchSet that matches the value BadBot in the User-Agent header

An IPSet that matches the IP address 192.0.2.44

You then add the Rule to a WebACL and specify that you want to block requests that satisfy the Rule. For a request to be blocked, the User-Agent header in the request must contain the value BadBotand the request must originate from the IP address 192.0.2.44.

To create and configure a Rule, perform the following steps:

Create and update the predicates that you want to include in the Rule.

If you want to replace one ByteMatchSet or IPSet with another, you delete the existing one and add the new one.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update a rule

# The following example deletes a Predicate object in a rule with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_rule({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",rule_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",updates:[{action:"DELETE",predicate:{data_id:"MyByteMatchSetID",negated:false,type:"ByteMatch",},},],})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

An array of RuleGroupUpdate objects that you want to insert into or
delete from a RuleGroup.

You can only insert REGULAR rules into a rule group.

ActivatedRule|OverrideAction applies only when updating or adding a
RuleGroup to a WebACL. In this case you do not use
ActivatedRule|Action. For all other update requests,
ActivatedRule|Action is used instead of
ActivatedRule|OverrideAction.

Whether to insert or delete the object from the array. If you want to change a SizeConstraintSetUpdate object, you delete the existing object and add a new one.

The part of a web request that you want AWS WAF to evaluate, such as the length of a query string or the length of the User-Agent header.

Whether to perform any transformations on the request, such as converting it to lowercase, before checking its length. Note that transformations of the request body are not supported because the AWS resource forwards only the first 8192 bytes of your request to AWS WAF.

You can only specify a single type of TextTransformation.

A ComparisonOperator used for evaluating the selected part of the request against the specified Size, such as equals, greater than, less than, and so on.

The length, in bytes, that you want AWS WAF to watch for in selected part of the request. The length is computed after applying the transformation.

For example, you can add a SizeConstraintSetUpdate object that matches web requests in which the length of the User-Agent header is greater than 100 bytes. You can then configure AWS WAF to block those requests.

To create and configure a SizeConstraintSet, perform the following steps:

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateSizeConstraintSet request.

Submit an UpdateSizeConstraintSet request to specify the part of the request that you want AWS WAF to inspect (for example, the header or the URI) and the value that you want AWS WAF to watch for.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update a size constraint set

# The following example deletes a SizeConstraint object (filters) in a size constraint set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_size_constraint_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",size_constraint_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",updates:[{action:"DELETE",size_constraint:{comparison_operator:"GT",field_to_match:{type:"QUERY_STRING",},size:0,text_transformation:"NONE",},},],})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

Action: Whether to insert the object into or delete the object from the array. To change a SqlInjectionMatchTuple, you delete the existing object and add a new one.

FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for snippets of malicious SQL code.

You can only specify a single type of TextTransformation.

You use SqlInjectionMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain snippets of SQL code in the query string and you want to block the requests, you can create a SqlInjectionMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

To create and configure a SqlInjectionMatchSet, perform the following steps:

Submit an UpdateSqlInjectionMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for snippets of SQL code.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update a SQL injection match set

# The following example deletes a SqlInjectionMatchTuple object (filters) in a SQL injection match set with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_sql_injection_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",sql_injection_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",updates:[{action:"DELETE",sql_injection_match_tuple:{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},},],})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes ActivatedRule objects in a WebACL. Each Rule identifies web requests that you want to allow, block, or count. When you update a WebACL, you specify the following values:

A default action for the WebACL, either ALLOW or BLOCK. AWS WAF performs the default action if a request doesn't match the criteria in any of the Rules in a WebACL.

The Rules that you want to add or delete. If you want to replace one Rule with another, you delete the existing Rule and add the new one.

For each Rule, whether you want AWS WAF to allow requests, block requests, or count requests that match the conditions in the Rule.

The order in which you want AWS WAF to evaluate the Rules in a WebACL. If you add more than one Rule to a WebACL, AWS WAF evaluates each request against the Rules in order based on the value of Priority. (The Rule that has the lowest value for Priority is evaluated first.) When a web request matches all the predicates (such as ByteMatchSets and IPSets) in a Rule, AWS WAF immediately takes the corresponding action, allow or block, and doesn't evaluate the request against the remaining Rules in the WebACL, if any.

Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of an UpdateWebACL request.

Submit an UpdateWebACL request to specify the Rules that you want to include in the WebACL, to specify the default action, and to associate the WebACL with a CloudFront distribution.

The ActivatedRule can be a rule group. If you specify a rule group as your ActivatedRule , you can exclude specific rules from that rule group.

If you already have a rule group associated with a web ACL and want to submit an UpdateWebACL request to exclude certain rules from that rule group, you must first remove the rule group from the web ACL, the re-insert it again, specifying the excluded rules. For details, see ActivatedRule$ExcludedRules .

Be aware that if you try to add a RATE_BASED rule to a web ACL without setting the rule type when first creating the rule, the UpdateWebACL request will fail because the request tries to add a REGULAR rule (the default rule type) with the specified ID, which does not exist.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update a Web ACL

# The following example deletes an ActivatedRule object in a WebACL with the ID webacl-1472061481310.
resp=client.update_web_acl({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",default_action:{type:"ALLOW",},updates:[{action:"DELETE",activated_rule:{action:{type:"ALLOW",},priority:1,rule_id:"WAFRule-1-Example",},},],web_acl_id:"webacl-1472061481310",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}

ActivatedRule: Contains Action, OverrideAction,
Priority, RuleId, and Type. ActivatedRule|OverrideAction
applies only when updating or adding a RuleGroup to a WebACL. In
this case, you do not use ActivatedRule|Action. For all other update
requests, ActivatedRule|Action is used instead of
ActivatedRule|OverrideAction.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic in the developer guide.

For the latest version of AWS WAF, use the AWS WAFV2 API and see the AWS WAF Developer Guide. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

Inserts or deletes XssMatchTuple objects (filters) in an XssMatchSet. For each XssMatchTuple object, you specify the following values:

Action: Whether to insert the object into or delete the object from the array. To change an XssMatchTuple, you delete the existing object and add a new one.

FieldToMatch: The part of web requests that you want AWS WAF to inspect and, if you want AWS WAF to inspect a header or custom query parameter, the name of the header or parameter.

TextTransformation: Which text transformation, if any, to perform on the web request before inspecting the request for cross-site scripting attacks.

You can only specify a single type of TextTransformation.

You use XssMatchSet objects to specify which CloudFront requests that you want to allow, block, or count. For example, if you're receiving requests that contain cross-site scripting attacks in the request body and you want to block the requests, you can create an XssMatchSet with the applicable settings, and then configure AWS WAF to block the requests.

Submit an UpdateXssMatchSet request to specify the parts of web requests that you want AWS WAF to inspect for cross-site scripting attacks.

For more information about how to use the AWS WAF API to allow or block HTTP requests, see the AWS WAF Developer Guide.

Examples:

Example: To update an XSS match set

# The following example deletes an XssMatchTuple object (filters) in an XssMatchSet with the ID example1ds3t-46da-4fdb-b8d5-abc321j569j5.
resp=client.update_xss_match_set({change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",updates:[{action:"DELETE",xss_match_tuple:{field_to_match:{type:"QUERY_STRING",},text_transformation:"URL_DECODE",},},],xss_match_set_id:"example1ds3t-46da-4fdb-b8d5-abc321j569j5",})# resp.to_h outputs the following:
{change_token:"abcd12f2-46da-4fdb-b8d5-fbd4c466928f",}