Update Ip Set
| wafv2_update_ip_set | R Documentation |
Updates the specified IPSet¶
Description¶
Updates the specified IPSet.
This operation completely replaces the mutable specifications that you already have for the IP set with the ones that you provide to this call.
To modify an IP set, do the following:
-
Retrieve it by calling
get_ip_set -
Update its settings as needed
-
Provide the complete IP set specification to this call
Temporary inconsistencies during updates
When you create or change a web ACL or other WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.
The following are examples of the temporary inconsistencies that you might notice during change propagation:
-
After you create a web ACL, if you try to associate it with a resource, you might get an exception indicating that the web ACL is unavailable.
-
After you add a rule group to a web ACL, the new rule group rules might be in effect in one area where the web ACL is used and not in another.
-
After you change a rule action setting, you might see the old action in some places and the new action in others.
-
After you add an IP address to an IP set that is in use in a blocking rule, the new address might be blocked in one area while still allowed in another.
Usage¶
wafv2_update_ip_set(Name, Scope, Id, Description, Addresses, LockToken)
Arguments¶
Name |
[required] The name of the IP set. You cannot change the name of
an |
Scope |
[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution. To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
|
Id |
[required] A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete. |
Description |
A description of the IP set that helps with identification. |
Addresses |
[required] Contains an array of strings that specifies zero or
more IP addresses or blocks of IP addresses that you want WAF to inspect
for in incoming requests. All addresses must be specified using
Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4
and IPv6 CIDR ranges except for Example address strings:
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing. Example JSON
|
LockToken |
[required] A token used for optimistic locking. WAF returns a
token to your |
Value¶
A list with the following syntax:
list(
NextLockToken = "string"
)
Request syntax¶
svc$update_ip_set(
Name = "string",
Scope = "CLOUDFRONT"|"REGIONAL",
Id = "string",
Description = "string",
Addresses = list(
"string"
),
LockToken = "string"
)