Class: Aws::WAFRegional::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::WAFRegional::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-wafregional/client.rb
Overview
An API client for WAFRegional. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::WAFRegional::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#associate_web_acl(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic Regional** documentation.
-
#create_byte_match_set(params = {}) ⇒ Types::CreateByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_geo_match_set(params = {}) ⇒ Types::CreateGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_ip_set(params = {}) ⇒ Types::CreateIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_rate_based_rule(params = {}) ⇒ Types::CreateRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_regex_match_set(params = {}) ⇒ Types::CreateRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_regex_pattern_set(params = {}) ⇒ Types::CreateRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_rule_group(params = {}) ⇒ Types::CreateRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_size_constraint_set(params = {}) ⇒ Types::CreateSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_sql_injection_match_set(params = {}) ⇒ Types::CreateSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_web_acl(params = {}) ⇒ Types::CreateWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#create_web_acl_migration_stack(params = {}) ⇒ Types::CreateWebACLMigrationStackResponse
Creates an AWS CloudFormation WAFV2 template for the specified web ACL in the specified Amazon S3 bucket.
-
#create_xss_match_set(params = {}) ⇒ Types::CreateXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_byte_match_set(params = {}) ⇒ Types::DeleteByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_geo_match_set(params = {}) ⇒ Types::DeleteGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_ip_set(params = {}) ⇒ Types::DeleteIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_logging_configuration(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_permission_policy(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_rate_based_rule(params = {}) ⇒ Types::DeleteRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_regex_match_set(params = {}) ⇒ Types::DeleteRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_regex_pattern_set(params = {}) ⇒ Types::DeleteRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_rule(params = {}) ⇒ Types::DeleteRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_size_constraint_set(params = {}) ⇒ Types::DeleteSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_sql_injection_match_set(params = {}) ⇒ Types::DeleteSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_web_acl(params = {}) ⇒ Types::DeleteWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#delete_xss_match_set(params = {}) ⇒ Types::DeleteXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#disassociate_web_acl(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic Regional** documentation.
-
#get_byte_match_set(params = {}) ⇒ Types::GetByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_change_token(params = {}) ⇒ Types::GetChangeTokenResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_change_token_status(params = {}) ⇒ Types::GetChangeTokenStatusResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_geo_match_set(params = {}) ⇒ Types::GetGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_ip_set(params = {}) ⇒ Types::GetIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_logging_configuration(params = {}) ⇒ Types::GetLoggingConfigurationResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_permission_policy(params = {}) ⇒ Types::GetPermissionPolicyResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_rate_based_rule(params = {}) ⇒ Types::GetRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_rate_based_rule_managed_keys(params = {}) ⇒ Types::GetRateBasedRuleManagedKeysResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_regex_match_set(params = {}) ⇒ Types::GetRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_regex_pattern_set(params = {}) ⇒ Types::GetRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_rule(params = {}) ⇒ Types::GetRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_rule_group(params = {}) ⇒ Types::GetRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_sampled_requests(params = {}) ⇒ Types::GetSampledRequestsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_size_constraint_set(params = {}) ⇒ Types::GetSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_sql_injection_match_set(params = {}) ⇒ Types::GetSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_web_acl(params = {}) ⇒ Types::GetWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#get_web_acl_for_resource(params = {}) ⇒ Types::GetWebACLForResourceResponse
<note markdown=“1”> This is **AWS WAF Classic Regional** documentation.
-
#get_xss_match_set(params = {}) ⇒ Types::GetXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_activated_rules_in_rule_group(params = {}) ⇒ Types::ListActivatedRulesInRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_byte_match_sets(params = {}) ⇒ Types::ListByteMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_geo_match_sets(params = {}) ⇒ Types::ListGeoMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_ip_sets(params = {}) ⇒ Types::ListIPSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_logging_configurations(params = {}) ⇒ Types::ListLoggingConfigurationsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_rate_based_rules(params = {}) ⇒ Types::ListRateBasedRulesResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_regex_match_sets(params = {}) ⇒ Types::ListRegexMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_regex_pattern_sets(params = {}) ⇒ Types::ListRegexPatternSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_resources_for_web_acl(params = {}) ⇒ Types::ListResourcesForWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic Regional** documentation.
-
#list_rule_groups(params = {}) ⇒ Types::ListRuleGroupsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_rules(params = {}) ⇒ Types::ListRulesResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_size_constraint_sets(params = {}) ⇒ Types::ListSizeConstraintSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_sql_injection_match_sets(params = {}) ⇒ Types::ListSqlInjectionMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_subscribed_rule_groups(params = {}) ⇒ Types::ListSubscribedRuleGroupsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_web_acls(params = {}) ⇒ Types::ListWebACLsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#list_xss_match_sets(params = {}) ⇒ Types::ListXssMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#put_logging_configuration(params = {}) ⇒ Types::PutLoggingConfigurationResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#put_permission_policy(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#tag_resource(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#untag_resource(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_byte_match_set(params = {}) ⇒ Types::UpdateByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_geo_match_set(params = {}) ⇒ Types::UpdateGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_ip_set(params = {}) ⇒ Types::UpdateIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_rate_based_rule(params = {}) ⇒ Types::UpdateRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_regex_match_set(params = {}) ⇒ Types::UpdateRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_regex_pattern_set(params = {}) ⇒ Types::UpdateRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_rule_group(params = {}) ⇒ Types::UpdateRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_size_constraint_set(params = {}) ⇒ Types::UpdateSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_sql_injection_match_set(params = {}) ⇒ Types::UpdateSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_web_acl(params = {}) ⇒ Types::UpdateWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
-
#update_xss_match_set(params = {}) ⇒ Types::UpdateXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
419 420 421 |
# File 'lib/aws-sdk-wafregional/client.rb', line 419 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6974 6975 6976 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6974 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6977 6978 6979 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6977 def errors_module Errors end |
Instance Method Details
#associate_web_acl(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic Regional** 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.
</note>
Associates a web ACL with a resource, either an application load balancer or Amazon API Gateway stage.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
471 472 473 474 |
# File 'lib/aws-sdk-wafregional/client.rb', line 471 def associate_web_acl(params = {}, = {}) req = build_request(:associate_web_acl, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6952 6953 6954 6955 6956 6957 6958 6959 6960 6961 6962 6963 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6952 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-wafregional' context[:gem_version] = '1.61.0' Seahorse::Client::Request.new(handlers, context) end |
#create_byte_match_set(params = {}) ⇒ Types::CreateByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
550 551 552 553 |
# File 'lib/aws-sdk-wafregional/client.rb', line 550 def create_byte_match_set(params = {}, = {}) req = build_request(:create_byte_match_set, params) req.send_request() end |
#create_geo_match_set(params = {}) ⇒ Types::CreateGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
625 626 627 628 |
# File 'lib/aws-sdk-wafregional/client.rb', line 625 def create_geo_match_set(params = {}, = {}) req = build_request(:create_geo_match_set, params) req.send_request() end |
#create_ip_set(params = {}) ⇒ Types::CreateIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
726 727 728 729 |
# File 'lib/aws-sdk-wafregional/client.rb', line 726 def create_ip_set(params = {}, = {}) req = build_request(:create_ip_set, params) req.send_request() end |
#create_rate_based_rule(params = {}) ⇒ Types::CreateRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
To create and configure a ‘RateBasedRule`, perform the following steps:
-
Create and update the predicates that you want to include in the rule. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `CreateRule` request.
-
Submit a ‘CreateRateBasedRule` request.
-
Use ‘GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateRule request.
-
Submit an ‘UpdateRateBasedRule` request to specify the predicates that you want to include in the rule.
-
Create and update a ‘WebACL` that contains the `RateBasedRule`. 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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
884 885 886 887 |
# File 'lib/aws-sdk-wafregional/client.rb', line 884 def create_rate_based_rule(params = {}, = {}) req = build_request(:create_rate_based_rule, params) req.send_request() end |
#create_regex_match_set(params = {}) ⇒ Types::CreateRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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@]dBt`. 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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
965 966 967 968 |
# File 'lib/aws-sdk-wafregional/client.rb', line 965 def create_regex_match_set(params = {}, = {}) req = build_request(:create_regex_match_set, params) req.send_request() end |
#create_regex_pattern_set(params = {}) ⇒ Types::CreateRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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@]dBt`. 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.
-
Submit an UpdateRegexPatternSet request to specify the string 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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1038 1039 1040 1041 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1038 def create_regex_pattern_set(params = {}, = {}) req = build_request(:create_regex_pattern_set, params) req.send_request() end |
#create_rule(params = {}) ⇒ Types::CreateRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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`.
To create and configure a ‘Rule`, perform the following steps:
-
Create and update the predicates that you want to include in the ‘Rule`. For more information, see CreateByteMatchSet, CreateIPSet, and CreateSqlInjectionMatchSet.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1175 1176 1177 1178 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1175 def create_rule(params = {}, = {}) req = build_request(:create_rule, params) req.send_request() end |
#create_rule_group(params = {}) ⇒ Types::CreateRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Creates a ‘RuleGroup`. A rule group is a collection of predefined rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the rule group.
Rule groups are subject to the following limits:
-
Three rule groups per account. You can request an increase to this limit by contacting customer support.
-
One rule group per web ACL.
-
Ten rules per rule group.
For more information about how to use the AWS WAF API to allow or block HTTP requests, see the [AWS WAF Developer Guide].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1258 1259 1260 1261 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1258 def create_rule_group(params = {}, = {}) req = build_request(:create_rule_group, params) req.send_request() end |
#create_size_constraint_set(params = {}) ⇒ Types::CreateSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1369 1370 1371 1372 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1369 def create_size_constraint_set(params = {}, = {}) req = build_request(:create_size_constraint_set, params) req.send_request() end |
#create_sql_injection_match_set(params = {}) ⇒ Types::CreateSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1474 1475 1476 1477 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1474 def create_sql_injection_match_set(params = {}, = {}) req = build_request(:create_sql_injection_match_set, params) req.send_request() end |
#create_web_acl(params = {}) ⇒ Types::CreateWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
To create and configure a ‘WebACL`, perform the following steps:
-
Create and update the ‘ByteMatchSet` objects and other predicates that you want to include in `Rules`. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
-
Create and update the ‘Rules` that you want to include in the `WebACL`. For more information, see CreateRule and UpdateRule.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `CreateWebACL` request.
-
Submit a ‘CreateWebACL` request.
-
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.
For more information about how to use the AWS WAF API, see the [AWS WAF Developer Guide].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1629 1630 1631 1632 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1629 def create_web_acl(params = {}, = {}) req = build_request(:create_web_acl, params) req.send_request() end |
#create_web_acl_migration_stack(params = {}) ⇒ Types::CreateWebACLMigrationStackResponse
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.
This is part of a larger migration procedure for web ACLs from AWS WAF Classic to the latest version of AWS WAF. For the full procedure, including caveats and manual steps to complete the migration and switch over to the new web ACL, see [Migrating your AWS WAF Classic resources to AWS WAF] in the [AWS WAF Developer Guide].
[1]: docs.aws.amazon.com/waf/latest/developerguide/waf-migrating-from-classic.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
1696 1697 1698 1699 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1696 def create_web_acl_migration_stack(params = {}, = {}) req = build_request(:create_web_acl_migration_stack, params) req.send_request() end |
#create_xss_match_set(params = {}) ⇒ Types::CreateXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
1798 1799 1800 1801 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1798 def create_xss_match_set(params = {}, = {}) req = build_request(:create_xss_match_set, params) req.send_request() end |
#delete_byte_match_set(params = {}) ⇒ Types::DeleteByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
1876 1877 1878 1879 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1876 def delete_byte_match_set(params = {}, = {}) req = build_request(:delete_byte_match_set, params) req.send_request() end |
#delete_geo_match_set(params = {}) ⇒ Types::DeleteGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a GeoMatchSet. You can’t delete a ‘GeoMatchSet` if it’s still used in any ‘Rules` or if it still includes any countries.
If you just want to remove a ‘GeoMatchSet` from a `Rule`, use UpdateRule.
To permanently delete a ‘GeoMatchSet` from AWS WAF, perform the following steps:
-
Update the ‘GeoMatchSet` to remove any countries. For more information, see UpdateGeoMatchSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteGeoMatchSet` request.
-
Submit a ‘DeleteGeoMatchSet` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
1940 1941 1942 1943 |
# File 'lib/aws-sdk-wafregional/client.rb', line 1940 def delete_geo_match_set(params = {}, = {}) req = build_request(:delete_geo_match_set, params) req.send_request() end |
#delete_ip_set(params = {}) ⇒ Types::DeleteIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes an IPSet. You can’t delete an ‘IPSet` if it’s still used in any ‘Rules` or if it still includes any IP addresses.
If you just want to remove an ‘IPSet` from a `Rule`, use UpdateRule.
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2016 2017 2018 2019 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2016 def delete_ip_set(params = {}, = {}) req = build_request(:delete_ip_set, params) req.send_request() end |
#delete_logging_configuration(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes the LoggingConfiguration from the specified web ACL.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2054 2055 2056 2057 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2054 def delete_logging_configuration(params = {}, = {}) req = build_request(:delete_logging_configuration, params) req.send_request() end |
#delete_permission_policy(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes an IAM policy from the specified RuleGroup.
The user making the request must be the owner of the RuleGroup.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2095 2096 2097 2098 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2095 def (params = {}, = {}) req = build_request(:delete_permission_policy, params) req.send_request() end |
#delete_rate_based_rule(params = {}) ⇒ Types::DeleteRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a RateBasedRule. You can’t delete a rule if it’s still used in any ‘WebACL` objects or if it still includes any predicates, such as `ByteMatchSet` objects.
If you just want to remove a rule from a ‘WebACL`, use UpdateWebACL.
To permanently delete a ‘RateBasedRule` from AWS WAF, perform the following steps:
-
Update the ‘RateBasedRule` to remove predicates, if any. For more information, see UpdateRateBasedRule.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteRateBasedRule` request.
-
Submit a ‘DeleteRateBasedRule` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2157 2158 2159 2160 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2157 def delete_rate_based_rule(params = {}, = {}) req = build_request(:delete_rate_based_rule, params) req.send_request() end |
#delete_regex_match_set(params = {}) ⇒ Types::DeleteRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a RegexMatchSet. You can’t delete a ‘RegexMatchSet` if it’s still used in any ‘Rules` or if it still includes any `RegexMatchTuples` objects (any filters).
If you just want to remove a ‘RegexMatchSet` from a `Rule`, use UpdateRule.
To permanently delete a ‘RegexMatchSet`, perform the following steps:
-
Update the ‘RegexMatchSet` to remove filters, if any. For more information, see UpdateRegexMatchSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteRegexMatchSet` request.
-
Submit a ‘DeleteRegexMatchSet` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2220 2221 2222 2223 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2220 def delete_regex_match_set(params = {}, = {}) req = build_request(:delete_regex_match_set, params) req.send_request() end |
#delete_regex_pattern_set(params = {}) ⇒ Types::DeleteRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a RegexPatternSet. You can’t delete a ‘RegexPatternSet` if it’s still used in any ‘RegexMatchSet` or if the `RegexPatternSet` is not empty.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2270 2271 2272 2273 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2270 def delete_regex_pattern_set(params = {}, = {}) req = build_request(:delete_regex_pattern_set, params) req.send_request() end |
#delete_rule(params = {}) ⇒ Types::DeleteRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a Rule. You can’t delete a ‘Rule` if it’s still used in any ‘WebACL` objects or if it still includes any predicates, such as `ByteMatchSet` objects.
If you just want to remove a ‘Rule` from a `WebACL`, use UpdateWebACL.
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2347 2348 2349 2350 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2347 def delete_rule(params = {}, = {}) req = build_request(:delete_rule, params) req.send_request() end |
#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a RuleGroup. You can’t delete a ‘RuleGroup` if it’s still used in any ‘WebACL` objects or if it still includes any rules.
If you just want to remove a ‘RuleGroup` from a `WebACL`, use UpdateWebACL.
To permanently delete a ‘RuleGroup` from AWS WAF, perform the following steps:
-
Update the ‘RuleGroup` to remove rules, if any. For more information, see UpdateRuleGroup.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteRuleGroup` request.
-
Submit a ‘DeleteRuleGroup` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2410 2411 2412 2413 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2410 def delete_rule_group(params = {}, = {}) req = build_request(:delete_rule_group, params) req.send_request() end |
#delete_size_constraint_set(params = {}) ⇒ Types::DeleteSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a SizeConstraintSet. You can’t delete a ‘SizeConstraintSet` if it’s still used in any ‘Rules` or if it still includes any SizeConstraint objects (any filters).
If you just want to remove a ‘SizeConstraintSet` from a `Rule`, use UpdateRule.
To permanently delete a ‘SizeConstraintSet`, perform the following steps:
-
Update the ‘SizeConstraintSet` to remove filters, if any. For more information, see UpdateSizeConstraintSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteSizeConstraintSet` request.
-
Submit a ‘DeleteSizeConstraintSet` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2489 2490 2491 2492 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2489 def delete_size_constraint_set(params = {}, = {}) req = build_request(:delete_size_constraint_set, params) req.send_request() end |
#delete_sql_injection_match_set(params = {}) ⇒ Types::DeleteSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Permanently deletes a SqlInjectionMatchSet. You can’t delete a ‘SqlInjectionMatchSet` if it’s still used in any ‘Rules` or if it still contains any SqlInjectionMatchTuple objects.
If you just want to remove a ‘SqlInjectionMatchSet` from a `Rule`, use UpdateRule.
To permanently delete a ‘SqlInjectionMatchSet` from AWS WAF, perform the following steps:
-
Update the ‘SqlInjectionMatchSet` to remove filters, if any. For more information, see UpdateSqlInjectionMatchSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of a `DeleteSqlInjectionMatchSet` request.
-
Submit a ‘DeleteSqlInjectionMatchSet` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2568 2569 2570 2571 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2568 def delete_sql_injection_match_set(params = {}, = {}) req = build_request(:delete_sql_injection_match_set, params) req.send_request() end |
#delete_web_acl(params = {}) ⇒ Types::DeleteWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2641 2642 2643 2644 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2641 def delete_web_acl(params = {}, = {}) req = build_request(:delete_web_acl, params) req.send_request() end |
#delete_xss_match_set(params = {}) ⇒ Types::DeleteXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2720 2721 2722 2723 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2720 def delete_xss_match_set(params = {}, = {}) req = build_request(:delete_xss_match_set, params) req.send_request() end |
#disassociate_web_acl(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic Regional** 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.
</note>
Removes a web ACL from the specified resource, either an application load balancer or Amazon API Gateway stage.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2768 2769 2770 2771 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2768 def disassociate_web_acl(params = {}, = {}) req = build_request(:disassociate_web_acl, params) req.send_request() end |
#get_byte_match_set(params = {}) ⇒ Types::GetByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the ByteMatchSet specified by ‘ByteMatchSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2847 2848 2849 2850 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2847 def get_byte_match_set(params = {}, = {}) req = build_request(:get_byte_match_set, params) req.send_request() end |
#get_change_token(params = {}) ⇒ Types::GetChangeTokenResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2907 2908 2909 2910 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2907 def get_change_token(params = {}, = {}) req = build_request(:get_change_token, params) req.send_request() end |
#get_change_token_status(params = {}) ⇒ Types::GetChangeTokenStatusResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
2974 2975 2976 2977 |
# File 'lib/aws-sdk-wafregional/client.rb', line 2974 def get_change_token_status(params = {}, = {}) req = build_request(:get_change_token_status, params) req.send_request() end |
#get_geo_match_set(params = {}) ⇒ Types::GetGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the GeoMatchSet that is specified by ‘GeoMatchSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3022 3023 3024 3025 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3022 def get_geo_match_set(params = {}, = {}) req = build_request(:get_geo_match_set, params) req.send_request() end |
#get_ip_set(params = {}) ⇒ Types::GetIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the IPSet that is specified by ‘IPSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3092 3093 3094 3095 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3092 def get_ip_set(params = {}, = {}) req = build_request(:get_ip_set, params) req.send_request() end |
#get_logging_configuration(params = {}) ⇒ Types::GetLoggingConfigurationResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the LoggingConfiguration for the specified web ACL.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3140 3141 3142 3143 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3140 def get_logging_configuration(params = {}, = {}) req = build_request(:get_logging_configuration, params) req.send_request() end |
#get_permission_policy(params = {}) ⇒ Types::GetPermissionPolicyResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the IAM policy attached to the RuleGroup.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3183 3184 3185 3186 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3183 def (params = {}, = {}) req = build_request(:get_permission_policy, params) req.send_request() end |
#get_rate_based_rule(params = {}) ⇒ Types::GetRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the RateBasedRule that is specified by the ‘RuleId` that you included in the `GetRateBasedRule` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3235 3236 3237 3238 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3235 def get_rate_based_rule(params = {}, = {}) req = build_request(:get_rate_based_rule, params) req.send_request() end |
#get_rate_based_rule_managed_keys(params = {}) ⇒ Types::GetRateBasedRuleManagedKeysResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3291 3292 3293 3294 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3291 def get_rate_based_rule_managed_keys(params = {}, = {}) req = build_request(:get_rate_based_rule_managed_keys, params) req.send_request() end |
#get_regex_match_set(params = {}) ⇒ Types::GetRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the RegexMatchSet specified by ‘RegexMatchSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3341 3342 3343 3344 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3341 def get_regex_match_set(params = {}, = {}) req = build_request(:get_regex_match_set, params) req.send_request() end |
#get_regex_pattern_set(params = {}) ⇒ Types::GetRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the RegexPatternSet specified by ‘RegexPatternSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3388 3389 3390 3391 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3388 def get_regex_pattern_set(params = {}, = {}) req = build_request(:get_regex_pattern_set, params) req.send_request() end |
#get_rule(params = {}) ⇒ Types::GetRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the Rule that is specified by the ‘RuleId` that you included in the `GetRule` request.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3463 3464 3465 3466 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3463 def get_rule(params = {}, = {}) req = build_request(:get_rule, params) req.send_request() end |
#get_rule_group(params = {}) ⇒ Types::GetRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the RuleGroup that is specified by the ‘RuleGroupId` that you included in the `GetRuleGroup` request.
To view the rules in a rule group, use ListActivatedRulesInRuleGroup.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3511 3512 3513 3514 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3511 def get_rule_group(params = {}, = {}) req = build_request(:get_rule_group, params) req.send_request() end |
#get_sampled_requests(params = {}) ⇒ Types::GetSampledRequestsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3659 3660 3661 3662 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3659 def get_sampled_requests(params = {}, = {}) req = build_request(:get_sampled_requests, params) req.send_request() end |
#get_size_constraint_set(params = {}) ⇒ Types::GetSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the SizeConstraintSet specified by ‘SizeConstraintSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3738 3739 3740 3741 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3738 def get_size_constraint_set(params = {}, = {}) req = build_request(:get_size_constraint_set, params) req.send_request() end |
#get_sql_injection_match_set(params = {}) ⇒ Types::GetSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the SqlInjectionMatchSet that is specified by ‘SqlInjectionMatchSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3814 3815 3816 3817 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3814 def get_sql_injection_match_set(params = {}, = {}) req = build_request(:get_sql_injection_match_set, params) req.send_request() end |
#get_web_acl(params = {}) ⇒ Types::GetWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the WebACL that is specified by ‘WebACLId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3899 3900 3901 3902 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3899 def get_web_acl(params = {}, = {}) req = build_request(:get_web_acl, params) req.send_request() end |
#get_web_acl_for_resource(params = {}) ⇒ Types::GetWebACLForResourceResponse
<note markdown=“1”> This is **AWS WAF Classic Regional** 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.
</note>
Returns the web ACL for the specified resource, either an application load balancer or Amazon API Gateway stage.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
3954 3955 3956 3957 |
# File 'lib/aws-sdk-wafregional/client.rb', line 3954 def get_web_acl_for_resource(params = {}, = {}) req = build_request(:get_web_acl_for_resource, params) req.send_request() end |
#get_xss_match_set(params = {}) ⇒ Types::GetXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns the XssMatchSet that is specified by ‘XssMatchSetId`.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4028 4029 4030 4031 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4028 def get_xss_match_set(params = {}, = {}) req = build_request(:get_xss_match_set, params) req.send_request() end |
#list_activated_rules_in_rule_group(params = {}) ⇒ Types::ListActivatedRulesInRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of ActivatedRule objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4097 4098 4099 4100 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4097 def list_activated_rules_in_rule_group(params = {}, = {}) req = build_request(:list_activated_rules_in_rule_group, params) req.send_request() end |
#list_byte_match_sets(params = {}) ⇒ Types::ListByteMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of ByteMatchSetSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4156 4157 4158 4159 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4156 def list_byte_match_sets(params = {}, = {}) req = build_request(:list_byte_match_sets, params) req.send_request() end |
#list_geo_match_sets(params = {}) ⇒ Types::ListGeoMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of GeoMatchSetSummary objects in the response.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4215 4216 4217 4218 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4215 def list_geo_match_sets(params = {}, = {}) req = build_request(:list_geo_match_sets, params) req.send_request() end |
#list_ip_sets(params = {}) ⇒ Types::ListIPSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of IPSetSummary objects in the response.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4290 4291 4292 4293 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4290 def list_ip_sets(params = {}, = {}) req = build_request(:list_ip_sets, params) req.send_request() end |
#list_logging_configurations(params = {}) ⇒ Types::ListLoggingConfigurationsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of LoggingConfiguration objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4354 4355 4356 4357 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4354 def list_logging_configurations(params = {}, = {}) req = build_request(:list_logging_configurations, params) req.send_request() end |
#list_rate_based_rules(params = {}) ⇒ Types::ListRateBasedRulesResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RuleSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4412 4413 4414 4415 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4412 def list_rate_based_rules(params = {}, = {}) req = build_request(:list_rate_based_rules, params) req.send_request() end |
#list_regex_match_sets(params = {}) ⇒ Types::ListRegexMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RegexMatchSetSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4471 4472 4473 4474 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4471 def list_regex_match_sets(params = {}, = {}) req = build_request(:list_regex_match_sets, params) req.send_request() end |
#list_regex_pattern_sets(params = {}) ⇒ Types::ListRegexPatternSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RegexPatternSetSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4531 4532 4533 4534 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4531 def list_regex_pattern_sets(params = {}, = {}) req = build_request(:list_regex_pattern_sets, params) req.send_request() end |
#list_resources_for_web_acl(params = {}) ⇒ Types::ListResourcesForWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic Regional** 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.
</note>
Returns an array of resources associated with the specified web ACL.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4580 4581 4582 4583 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4580 def list_resources_for_web_acl(params = {}, = {}) req = build_request(:list_resources_for_web_acl, params) req.send_request() end |
#list_rule_groups(params = {}) ⇒ Types::ListRuleGroupsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RuleGroup objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4638 4639 4640 4641 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4638 def list_rule_groups(params = {}, = {}) req = build_request(:list_rule_groups, params) req.send_request() end |
#list_rules(params = {}) ⇒ Types::ListRulesResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RuleSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4715 4716 4717 4718 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4715 def list_rules(params = {}, = {}) req = build_request(:list_rules, params) req.send_request() end |
#list_size_constraint_sets(params = {}) ⇒ Types::ListSizeConstraintSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of SizeConstraintSetSummary objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4794 4795 4796 4797 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4794 def list_size_constraint_sets(params = {}, = {}) req = build_request(:list_size_constraint_sets, params) req.send_request() end |
#list_sql_injection_match_sets(params = {}) ⇒ Types::ListSqlInjectionMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of SqlInjectionMatchSet objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4873 4874 4875 4876 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4873 def list_sql_injection_match_sets(params = {}, = {}) req = build_request(:list_sql_injection_match_sets, params) req.send_request() end |
#list_subscribed_rule_groups(params = {}) ⇒ Types::ListSubscribedRuleGroupsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of RuleGroup objects that you are subscribed to.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4933 4934 4935 4936 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4933 def list_subscribed_rule_groups(params = {}, = {}) req = build_request(:list_subscribed_rule_groups, params) req.send_request() end |
#list_tags_for_resource(params = {}) ⇒ Types::ListTagsForResourceResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
4995 4996 4997 4998 |
# File 'lib/aws-sdk-wafregional/client.rb', line 4995 def (params = {}, = {}) req = build_request(:list_tags_for_resource, params) req.send_request() end |
#list_web_acls(params = {}) ⇒ Types::ListWebACLsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of WebACLSummary objects in the response.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
5073 5074 5075 5076 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5073 def list_web_acls(params = {}, = {}) req = build_request(:list_web_acls, params) req.send_request() end |
#list_xss_match_sets(params = {}) ⇒ Types::ListXssMatchSetsResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Returns an array of XssMatchSet objects.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
5150 5151 5152 5153 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5150 def list_xss_match_sets(params = {}, = {}) req = build_request(:list_xss_match_sets, params) req.send_request() end |
#put_logging_configuration(params = {}) ⇒ Types::PutLoggingConfigurationResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Associates a LoggingConfiguration with a specified web ACL.
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).
<note markdown=“1”> Do not create the data firehose using a ‘Kinesis stream` as your source.
</note>
-
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*.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/logging.html
5237 5238 5239 5240 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5237 def put_logging_configuration(params = {}, = {}) req = build_request(:put_logging_configuration, params) req.send_request() end |
#put_permission_policy(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Attaches an IAM policy to the specified resource. The only supported use for this action is to share a RuleGroup across accounts.
The ‘PutPermissionPolicy` is subject to the following restrictions:
-
You can attach only one policy with each ‘PutPermissionPolicy` request.
-
The policy must include an ‘Effect`, `Action` and `Principal`.
-
‘Effect` must specify `Allow`.
-
The ‘Action` in the policy must be `waf:UpdateWebACL`, `waf-regional:UpdateWebACL`, `waf:GetRuleGroup` and `waf-regional:GetRuleGroup` . Any extra or wildcard actions in the policy will be rejected.
-
The policy cannot include a ‘Resource` parameter.
-
The ARN in the request must be a valid WAF RuleGroup ARN and the RuleGroup must exist in the same region.
-
The user making the request must be the owner of the RuleGroup.
-
Your policy must be composed using IAM Policy version 2012-10-17.
For more information, see [IAM Policies].
An example of a valid policy parameter is shown in the Examples section below.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html
5308 5309 5310 5311 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5308 def (params = {}, = {}) req = build_request(:put_permission_policy, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
5361 5362 5363 5364 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5361 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
5399 5400 5401 5402 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5399 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_byte_match_set(params = {}) ⇒ Types::UpdateByteMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
To create and configure a ‘ByteMatchSet`, perform the following steps:
-
Create a ‘ByteMatchSet.` For more information, see CreateByteMatchSet.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
5543 5544 5545 5546 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5543 def update_byte_match_set(params = {}, = {}) req = build_request(:update_byte_match_set, params) req.send_request() end |
#update_geo_match_set(params = {}) ⇒ Types::UpdateGeoMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes GeoMatchConstraint objects in an ‘GeoMatchSet`. For each `GeoMatchConstraint` object, you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change an ‘GeoMatchConstraint` object, you delete the existing object and add a new one.
-
The ‘Type`. The only valid value for `Type` is `Country`.
-
The ‘Value`, which is a two character code for the country to add to the `GeoMatchConstraint` object. Valid codes are listed in GeoMatchConstraint$Value.
To create and configure an ‘GeoMatchSet`, perform the following steps:
-
Submit a CreateGeoMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of an UpdateGeoMatchSet request.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
5642 5643 5644 5645 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5642 def update_geo_match_set(params = {}, = {}) req = build_request(:update_geo_match_set, params) req.send_request() end |
#update_ip_set(params = {}) ⇒ Types::UpdateIPSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes IPSetDescriptor objects in an ‘IPSet`. For each `IPSetDescriptor` object, you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change an ‘IPSetDescriptor` object, you delete the existing object and add a new one.
-
The IP address version, ‘IPv4` or `IPv6`.
-
The IP address in CIDR notation, for example, ‘192.0.2.0/24` (for the range of IP addresses from `192.0.2.0` to `192.0.2.255`) or `192.0.2.44/32` (for the individual IP address `192.0.2.44`).
AWS WAF supports IPv4 address ranges: /8 and any range between /16 through /32. AWS WAF supports IPv6 address ranges: /24, /32, /48, /56, /64, and /128. For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing].
IPv6 addresses can be represented using any of the following formats:
-
1111:0000:0000:0000:0000:0000:0000:0111/128
-
1111:0:0:0:0:0:0:0111/128
-
1111::0111/128
-
1111::111/128
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.
To create and configure an ‘IPSet`, perform the following steps:
-
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.
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: en.wikipedia.org/wiki/Classless_Inter-Domain_Routing [4]: docs.aws.amazon.com/waf/latest/developerguide/
5789 5790 5791 5792 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5789 def update_ip_set(params = {}, = {}) req = build_request(:update_ip_set, params) req.send_request() end |
#update_rate_based_rule(params = {}) ⇒ Types::UpdateRateBasedRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html
5898 5899 5900 5901 |
# File 'lib/aws-sdk-wafregional/client.rb', line 5898 def update_rate_based_rule(params = {}, = {}) req = build_request(:update_rate_based_rule, params) req.send_request() end |
#update_regex_match_set(params = {}) ⇒ Types::UpdateRegexMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes RegexMatchTuple objects (filters) in a RegexMatchSet. For each ‘RegexMatchSetUpdate` object, you specify the following values:
-
Whether to insert or delete the object from the array. If you want to change a ‘RegexMatchSetUpdate` object, you delete the existing object and add a new one.
-
The part of a web request that you want AWS WAF to inspectupdate, such as a query string or the value of the ‘User-Agent` header.
-
The identifier of the pattern (a regular expression) that you want AWS WAF to look for. For more information, see RegexPatternSet.
-
Whether to perform any conversions on the request, such as converting it to lowercase, before inspecting it for the specified string.
For example, you can create a ‘RegexPatternSet` that matches any requests with `User-Agent` headers that contain the string `B[a@]dBt`. You can then configure AWS WAF to reject those requests.
To create and configure a ‘RegexMatchSet`, perform the following steps:
-
Create a ‘RegexMatchSet.` For more information, see CreateRegexMatchSet.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6004 6005 6006 6007 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6004 def update_regex_match_set(params = {}, = {}) req = build_request(:update_regex_match_set, params) req.send_request() end |
#update_regex_pattern_set(params = {}) ⇒ Types::UpdateRegexPatternSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes ‘RegexPatternString` objects in a RegexPatternSet. For each `RegexPatternString` object, you specify the following values:
-
Whether to insert or delete the ‘RegexPatternString`.
-
The regular expression pattern that you want to insert or delete. For more information, see RegexPatternSet.
For example, you can create a ‘RegexPatternString` such as `B[a@]dBt`. AWS WAF will match this `RegexPatternString` to:
-
BadBot
-
BadB0t
-
B@dBot
-
B@dB0t
To create and configure a ‘RegexPatternSet`, perform the following steps:
-
Create a ‘RegexPatternSet.` For more information, see CreateRegexPatternSet.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of an `UpdateRegexPatternSet` request.
-
Submit an ‘UpdateRegexPatternSet` request to specify the regular expression pattern 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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6096 6097 6098 6099 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6096 def update_regex_pattern_set(params = {}, = {}) req = build_request(:update_regex_pattern_set, params) req.send_request() end |
#update_rule(params = {}) ⇒ Types::UpdateRuleResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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 `BadBot` and 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`.
-
Create the ‘Rule`. See CreateRule.
-
Use ‘GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateRule request.
-
Submit an ‘UpdateRule` request to add predicates to the `Rule`.
-
Create and update a ‘WebACL` that contains the `Rule`. See CreateWebACL.
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6226 6227 6228 6229 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6226 def update_rule(params = {}, = {}) req = build_request(:update_rule, params) req.send_request() end |
#update_rule_group(params = {}) ⇒ Types::UpdateRuleGroupResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes ActivatedRule objects in a ‘RuleGroup`.
You can only insert ‘REGULAR` rules into a rule group.
You can have a maximum of ten rules per rule group.
To create and configure a ‘RuleGroup`, perform the following steps:
-
Create and update the ‘Rules` that you want to include in the `RuleGroup`. See CreateRule.
-
Use ‘GetChangeToken` to get the change token that you provide in the `ChangeToken` parameter of an UpdateRuleGroup request.
-
Submit an ‘UpdateRuleGroup` request to add `Rules` to the `RuleGroup`.
-
Create and update a ‘WebACL` that contains the `RuleGroup`. See CreateWebACL.
If you want to replace one ‘Rule` 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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6331 6332 6333 6334 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6331 def update_rule_group(params = {}, = {}) req = build_request(:update_rule_group, params) req.send_request() end |
#update_size_constraint_set(params = {}) ⇒ Types::UpdateSizeConstraintSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes SizeConstraint objects (filters) in a SizeConstraintSet. For each ‘SizeConstraint` object, you specify the following values:
-
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:
-
Create a ‘SizeConstraintSet.` For more information, see CreateSizeConstraintSet.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6483 6484 6485 6486 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6483 def update_size_constraint_set(params = {}, = {}) req = build_request(:update_size_constraint_set, params) req.send_request() end |
#update_sql_injection_match_set(params = {}) ⇒ Types::UpdateSqlInjectionMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
Inserts or deletes SqlInjectionMatchTuple objects (filters) in a SqlInjectionMatchSet. For each ‘SqlInjectionMatchTuple` object, you specify the following values:
-
‘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 a CreateSqlInjectionMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of an UpdateIPSet request.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6622 6623 6624 6625 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6622 def update_sql_injection_match_set(params = {}, = {}) req = build_request(:update_sql_injection_match_set, params) req.send_request() end |
#update_web_acl(params = {}) ⇒ Types::UpdateWebACLResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
To create and configure a ‘WebACL`, perform the following steps:
-
Create and update the predicates that you want to include in ‘Rules`. For more information, see CreateByteMatchSet, UpdateByteMatchSet, CreateIPSet, UpdateIPSet, CreateSqlInjectionMatchSet, and UpdateSqlInjectionMatchSet.
-
Create and update the ‘Rules` that you want to include in the `WebACL`. For more information, see CreateRule and UpdateRule.
-
Create a ‘WebACL`. See CreateWebACL.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6808 6809 6810 6811 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6808 def update_web_acl(params = {}, = {}) req = build_request(:update_web_acl, params) req.send_request() end |
#update_xss_match_set(params = {}) ⇒ Types::UpdateXssMatchSetResponse
<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see
- AWS WAF Classic][1
-
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.
</note>
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.
To create and configure an ‘XssMatchSet`, perform the following steps:
-
Submit a CreateXssMatchSet request.
-
Use GetChangeToken to get the change token that you provide in the ‘ChangeToken` parameter of an UpdateIPSet request.
-
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].
[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html [3]: docs.aws.amazon.com/waf/latest/developerguide/
6943 6944 6945 6946 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6943 def update_xss_match_set(params = {}, = {}) req = build_request(:update_xss_match_set, params) req.send_request() end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
6967 6968 6969 |
# File 'lib/aws-sdk-wafregional/client.rb', line 6967 def waiter_names [] end |