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

Amazonka.WAFV2.UpdateIPSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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 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' {
- description :: Maybe Text
- name :: Text
- scope :: Scope
- id :: Text
- addresses :: [Text]
- lockToken :: Text
}
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.

Constructors

UpdateIPSet'

Fields

description :: Maybe Text
A description of the IP set that helps with identification.
name :: Text
The name of the IP set. You cannot change the name of an IPSet after you create it.
scope :: 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.
id :: Text
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.
addresses :: [Text]
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
lockToken :: Text
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.

Instances

Instances details

ToJSON UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods toJSON :: UpdateIPSet -> Value # toEncoding :: UpdateIPSet -> Encoding # toJSONList :: [UpdateIPSet] -> Value # toEncodingList :: [UpdateIPSet] -> Encoding #
ToHeaders UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods toHeaders :: UpdateIPSet -> [Header] #
ToPath UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods toPath :: UpdateIPSet -> ByteString #
ToQuery UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods toQuery :: UpdateIPSet -> QueryString #
AWSRequest UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Associated Types type AWSResponse UpdateIPSet # Methods request :: (Service -> Service) -> UpdateIPSet -> Request UpdateIPSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateIPSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateIPSet))) #
Generic UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Associated Types type Rep UpdateIPSet :: Type -> Type # Methods from :: UpdateIPSet -> Rep UpdateIPSet x # to :: Rep UpdateIPSet x -> UpdateIPSet #
Read UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods readsPrec :: Int -> ReadS UpdateIPSet # readList :: ReadS [UpdateIPSet] # readPrec :: ReadPrec UpdateIPSet # readListPrec :: ReadPrec [UpdateIPSet] #
Show UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods showsPrec :: Int -> UpdateIPSet -> ShowS # show :: UpdateIPSet -> String # showList :: [UpdateIPSet] -> ShowS #
NFData UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods rnf :: UpdateIPSet -> () #
Eq UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods (==) :: UpdateIPSet -> UpdateIPSet -> Bool # (/=) :: UpdateIPSet -> UpdateIPSet -> Bool #
Hashable UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods hashWithSalt :: Int -> UpdateIPSet -> Int # hash :: UpdateIPSet -> Int #
type AWSResponse UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet type AWSResponse UpdateIPSet = UpdateIPSetResponse
type Rep UpdateIPSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet type Rep UpdateIPSet = D1 ('MetaData "UpdateIPSet" "Amazonka.WAFV2.UpdateIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "UpdateIPSet'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "scope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Scope))) :: (S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "addresses") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateIPSet Source #

Arguments

:: Text	`UpdateIPSet`
-> Scope	`UpdateIPSet`
-> Text	`UpdateIPSet`
-> Text	`UpdateIPSet`
-> UpdateIPSet

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.

Constructors

UpdateIPSetResponse'
Fields nextLockToken :: Maybe Text 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`. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Associated Types type Rep UpdateIPSetResponse :: Type -> Type # Methods from :: UpdateIPSetResponse -> Rep UpdateIPSetResponse x # to :: Rep UpdateIPSetResponse x -> UpdateIPSetResponse #
Read UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods readsPrec :: Int -> ReadS UpdateIPSetResponse # readList :: ReadS [UpdateIPSetResponse] # readPrec :: ReadPrec UpdateIPSetResponse # readListPrec :: ReadPrec [UpdateIPSetResponse] #
Show UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods showsPrec :: Int -> UpdateIPSetResponse -> ShowS # show :: UpdateIPSetResponse -> String # showList :: [UpdateIPSetResponse] -> ShowS #
NFData UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods rnf :: UpdateIPSetResponse -> () #
Eq UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet Methods (==) :: UpdateIPSetResponse -> UpdateIPSetResponse -> Bool # (/=) :: UpdateIPSetResponse -> UpdateIPSetResponse -> Bool #
type Rep UpdateIPSetResponse Source #
Instance details Defined in Amazonka.WAFV2.UpdateIPSet type Rep UpdateIPSetResponse = D1 ('MetaData "UpdateIPSetResponse" "Amazonka.WAFV2.UpdateIPSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "UpdateIPSetResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextLockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newUpdateIPSetResponse Source #

Arguments

:: Int	`$sel:httpStatus:UpdateIPSetResponse'`
-> UpdateIPSetResponse

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.