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.UpdateRegexPatternSet

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified RegexPatternSet.

This operation completely replaces the mutable specifications that you already have for the regex pattern set with the ones that you provide to this call. To modify the regex pattern set, retrieve it by calling GetRegexPatternSet, update the settings as needed, and then provide the complete regex pattern 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 UpdateRegexPatternSet = UpdateRegexPatternSet' {
- description :: Maybe Text
- name :: Text
- scope :: Scope
- id :: Text
- regularExpressionList :: [Regex]
- lockToken :: Text
}
newUpdateRegexPatternSet :: Text -> Scope -> Text -> Text -> UpdateRegexPatternSet
updateRegexPatternSet_description :: Lens' UpdateRegexPatternSet (Maybe Text)
updateRegexPatternSet_name :: Lens' UpdateRegexPatternSet Text
updateRegexPatternSet_scope :: Lens' UpdateRegexPatternSet Scope
updateRegexPatternSet_id :: Lens' UpdateRegexPatternSet Text
updateRegexPatternSet_regularExpressionList :: Lens' UpdateRegexPatternSet [Regex]
updateRegexPatternSet_lockToken :: Lens' UpdateRegexPatternSet Text
data UpdateRegexPatternSetResponse = UpdateRegexPatternSetResponse' {
- nextLockToken :: Maybe Text
- httpStatus :: Int
}
newUpdateRegexPatternSetResponse :: Int -> UpdateRegexPatternSetResponse
updateRegexPatternSetResponse_nextLockToken :: Lens' UpdateRegexPatternSetResponse (Maybe Text)
updateRegexPatternSetResponse_httpStatus :: Lens' UpdateRegexPatternSetResponse Int

Creating a Request

data UpdateRegexPatternSet Source #

See: newUpdateRegexPatternSet smart constructor.

Constructors

UpdateRegexPatternSet'

Fields

description :: Maybe Text
A description of the set that helps with identification.
name :: Text
The name of the set. You cannot change the name after you create the set.
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.
regularExpressionList :: [Regex]
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 UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods toJSON :: UpdateRegexPatternSet -> Value # toEncoding :: UpdateRegexPatternSet -> Encoding # toJSONList :: [UpdateRegexPatternSet] -> Value # toEncodingList :: [UpdateRegexPatternSet] -> Encoding #
ToHeaders UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods toHeaders :: UpdateRegexPatternSet -> [Header] #
ToPath UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods toPath :: UpdateRegexPatternSet -> ByteString #
ToQuery UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods toQuery :: UpdateRegexPatternSet -> QueryString #
AWSRequest UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Associated Types type AWSResponse UpdateRegexPatternSet # Methods request :: (Service -> Service) -> UpdateRegexPatternSet -> Request UpdateRegexPatternSet # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateRegexPatternSet -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateRegexPatternSet))) #
Generic UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Associated Types type Rep UpdateRegexPatternSet :: Type -> Type # Methods from :: UpdateRegexPatternSet -> Rep UpdateRegexPatternSet x # to :: Rep UpdateRegexPatternSet x -> UpdateRegexPatternSet #
Read UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods readsPrec :: Int -> ReadS UpdateRegexPatternSet # readList :: ReadS [UpdateRegexPatternSet] # readPrec :: ReadPrec UpdateRegexPatternSet # readListPrec :: ReadPrec [UpdateRegexPatternSet] #
Show UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods showsPrec :: Int -> UpdateRegexPatternSet -> ShowS # show :: UpdateRegexPatternSet -> String # showList :: [UpdateRegexPatternSet] -> ShowS #
NFData UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods rnf :: UpdateRegexPatternSet -> () #
Eq UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods (==) :: UpdateRegexPatternSet -> UpdateRegexPatternSet -> Bool # (/=) :: UpdateRegexPatternSet -> UpdateRegexPatternSet -> Bool #
Hashable UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet Methods hashWithSalt :: Int -> UpdateRegexPatternSet -> Int # hash :: UpdateRegexPatternSet -> Int #
type AWSResponse UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet type AWSResponse UpdateRegexPatternSet = UpdateRegexPatternSetResponse
type Rep UpdateRegexPatternSet Source #
Instance details Defined in Amazonka.WAFV2.UpdateRegexPatternSet type Rep UpdateRegexPatternSet = D1 ('MetaData "UpdateRegexPatternSet" "Amazonka.WAFV2.UpdateRegexPatternSet" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "UpdateRegexPatternSet'" '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 "regularExpressionList") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Regex]) :*: S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newUpdateRegexPatternSet Source #

Arguments

:: Text	`UpdateRegexPatternSet`
-> Scope	`UpdateRegexPatternSet`
-> Text	`UpdateRegexPatternSet`
-> Text	`UpdateRegexPatternSet`
-> UpdateRegexPatternSet

Create a value of UpdateRegexPatternSet 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:

UpdateRegexPatternSet, updateRegexPatternSet_description - A description of the set that helps with identification.

UpdateRegexPatternSet, updateRegexPatternSet_name - The name of the set. You cannot change the name after you create the set.

UpdateRegexPatternSet, updateRegexPatternSet_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.

UpdateRegexPatternSet, updateRegexPatternSet_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.

UpdateRegexPatternSet, updateRegexPatternSet_regularExpressionList -

UpdateRegexPatternSet, updateRegexPatternSet_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

updateRegexPatternSet_description :: Lens' UpdateRegexPatternSet (Maybe Text) Source #

A description of the set that helps with identification.

updateRegexPatternSet_name :: Lens' UpdateRegexPatternSet Text Source #

The name of the set. You cannot change the name after you create the set.

updateRegexPatternSet_scope :: Lens' UpdateRegexPatternSet 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.

updateRegexPatternSet_id :: Lens' UpdateRegexPatternSet 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.

updateRegexPatternSet_regularExpressionList :: Lens' UpdateRegexPatternSet [Regex] Source #

updateRegexPatternSet_lockToken :: Lens' UpdateRegexPatternSet 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 UpdateRegexPatternSetResponse Source #

See: newUpdateRegexPatternSetResponse smart constructor.

Constructors

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

newUpdateRegexPatternSetResponse Source #

Arguments

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

Create a value of UpdateRegexPatternSetResponse 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:UpdateRegexPatternSetResponse', updateRegexPatternSetResponse_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:UpdateRegexPatternSetResponse', updateRegexPatternSetResponse_httpStatus - The response's http status code.

Response Lenses

updateRegexPatternSetResponse_nextLockToken :: Lens' UpdateRegexPatternSetResponse (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.

updateRegexPatternSetResponse_httpStatus :: Lens' UpdateRegexPatternSetResponse Int Source #

The response's http status code.