Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
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 the IP set, retrieve it by calling GetIPSet, update the settings as needed, and then provide the complete IP set specification to this call.
When you make changes to web ACLs or web ACL components, like rules and rule groups, WAF propagates the changes everywhere that the web ACL and its components are stored and used. Your changes are applied within seconds, but there might be a brief period of inconsistency when the changes have arrived in some places and not in others. So, for example, if you change a rule action setting, the action might be the old action in one area and the new action in another area. Or if you add an IP address to an IP set used in a blocking rule, the new address might briefly be blocked in one area while still allowed in another. This temporary inconsistency can occur when you first associate a web ACL with an Amazon Web Services resource and when you change a web ACL that is already associated with a resource. Generally, any inconsistencies of this type last only a few seconds.
Synopsis
- data UpdateIPSet = UpdateIPSet' {}
- newUpdateIPSet :: Text -> Scope -> Text -> Text -> UpdateIPSet
- updateIPSet_description :: Lens' UpdateIPSet (Maybe Text)
- updateIPSet_name :: Lens' UpdateIPSet Text
- updateIPSet_scope :: Lens' UpdateIPSet Scope
- updateIPSet_id :: Lens' UpdateIPSet Text
- updateIPSet_addresses :: Lens' UpdateIPSet [Text]
- updateIPSet_lockToken :: Lens' UpdateIPSet Text
- data UpdateIPSetResponse = UpdateIPSetResponse' {
- nextLockToken :: Maybe Text
- httpStatus :: Int
- newUpdateIPSetResponse :: Int -> UpdateIPSetResponse
- updateIPSetResponse_nextLockToken :: Lens' UpdateIPSetResponse (Maybe Text)
- updateIPSetResponse_httpStatus :: Lens' UpdateIPSetResponse Int
Creating a Request
data UpdateIPSet Source #
See: newUpdateIPSet
smart constructor.
UpdateIPSet' | |
|
Instances
Create a value of UpdateIPSet
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateIPSet
, updateIPSet_description
- A description of the IP set that helps with identification.
UpdateIPSet
, updateIPSet_name
- The name of the IP set. You cannot change the name of an IPSet
after
you create it.
UpdateIPSet
, updateIPSet_scope
- Specifies whether this is for an Amazon CloudFront distribution or for a
regional application. A regional application can be an Application Load
Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API,
or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. - API and SDKs - For all calls, use the Region endpoint us-east-1.
UpdateIPSet
, updateIPSet_id
- A unique identifier for the set. This ID is returned in the responses to
create and list commands. You provide it to operations like update and
delete.
UpdateIPSet
, updateIPSet_addresses
- Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses. All addresses must be specified using Classless
Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6
CIDR ranges except for /0
.
Example address strings:
- To configure WAF to allow, block, or count requests that originated
from the IP address 192.0.2.44, specify
192.0.2.44/32
. - To configure WAF to allow, block, or count requests that originated
from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
. - To configure WAF to allow, block, or count requests that originated
from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. - To configure WAF to allow, block, or count requests that originated
from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to
1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
- Empty array:
"Addresses": []
- Array with one address:
"Addresses": ["192.0.2.44/32"]
- Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification:
"Addresses": [""]
INVALID
UpdateIPSet
, updateIPSet_lockToken
- A token used for optimistic locking. WAF returns a token to your get
and list
requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update
and delete
. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException
. If this happens, perform another get
,
and use the new token returned by that operation.
Request Lenses
updateIPSet_description :: Lens' UpdateIPSet (Maybe Text) Source #
A description of the IP set that helps with identification.
updateIPSet_name :: Lens' UpdateIPSet Text Source #
The name of the IP set. You cannot change the name of an IPSet
after
you create it.
updateIPSet_scope :: Lens' UpdateIPSet Scope Source #
Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, or an Amazon Cognito user pool.
To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
- CLI - Specify the Region when you use the CloudFront scope:
--scope=CLOUDFRONT --region=us-east-1
. - API and SDKs - For all calls, use the Region endpoint us-east-1.
updateIPSet_id :: Lens' UpdateIPSet Text Source #
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.
updateIPSet_addresses :: Lens' UpdateIPSet [Text] Source #
Contains an array of strings that specifies zero or more IP addresses or
blocks of IP addresses. All addresses must be specified using Classless
Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6
CIDR ranges except for /0
.
Example address strings:
- To configure WAF to allow, block, or count requests that originated
from the IP address 192.0.2.44, specify
192.0.2.44/32
. - To configure WAF to allow, block, or count requests that originated
from IP addresses from 192.0.2.0 to 192.0.2.255, specify
192.0.2.0/24
. - To configure WAF to allow, block, or count requests that originated
from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify
1111:0000:0000:0000:0000:0000:0000:0111/128
. - To configure WAF to allow, block, or count requests that originated
from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to
1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify
1111:0000:0000:0000:0000:0000:0000:0000/64
.
For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
Example JSON Addresses
specifications:
- Empty array:
"Addresses": []
- Array with one address:
"Addresses": ["192.0.2.44/32"]
- Array with three addresses:
"Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
- INVALID specification:
"Addresses": [""]
INVALID
updateIPSet_lockToken :: Lens' UpdateIPSet Text Source #
A token used for optimistic locking. WAF returns a token to your get
and list
requests, to mark the state of the entity at the time of the
request. To make changes to the entity associated with the token, you
provide the token to operations like update
and delete
. WAF uses the
token to ensure that no changes have been made to the entity since you
last retrieved it. If a change has been made, the update fails with a
WAFOptimisticLockException
. If this happens, perform another get
,
and use the new token returned by that operation.
Destructuring the Response
data UpdateIPSetResponse Source #
See: newUpdateIPSetResponse
smart constructor.
UpdateIPSetResponse' | |
|
Instances
newUpdateIPSetResponse Source #
Create a value of UpdateIPSetResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:nextLockToken:UpdateIPSetResponse'
, updateIPSetResponse_nextLockToken
- A token used for optimistic locking. WAF returns this token to your
update
requests. You use NextLockToken
in the same manner as you use
LockToken
.
$sel:httpStatus:UpdateIPSetResponse'
, updateIPSetResponse_httpStatus
- The response's http status code.
Response Lenses
updateIPSetResponse_nextLockToken :: Lens' UpdateIPSetResponse (Maybe Text) Source #
A token used for optimistic locking. WAF returns this token to your
update
requests. You use NextLockToken
in the same manner as you use
LockToken
.
updateIPSetResponse_httpStatus :: Lens' UpdateIPSetResponse Int Source #
The response's http status code.