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

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Updates the specified WebACL. While updating a web ACL, WAF provides continuous coverage to the resources that you have associated with the web ACL.

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.

This operation completely replaces the mutable specifications that you already have for the web ACL with the ones that you provide to this call. To modify the web ACL, retrieve it by calling GetWebACL, update the settings as needed, and then provide the complete web ACL specification to this call.

A web ACL defines a collection of rules to use to inspect and control web requests. Each rule has an action defined (allow, block, or count) for requests that match the statement of the rule. In the web ACL, you assign a default action to take (allow, block) for any request that does not match any of the rules. The rules in a web ACL can be a combination of the types Rule, RuleGroup, and managed rule group. You can associate a web ACL with one or more Amazon Web Services resources to protect. The resources can be an Amazon CloudFront distribution, an Amazon API Gateway REST API, an Application Load Balancer, an AppSync GraphQL API, or an Amazon Cognito user pool.

Synopsis

data UpdateWebACL = UpdateWebACL' {
- captchaConfig :: Maybe CaptchaConfig
- challengeConfig :: Maybe ChallengeConfig
- customResponseBodies :: Maybe (HashMap Text CustomResponseBody)
- description :: Maybe Text
- rules :: Maybe [Rule]
- tokenDomains :: Maybe (NonEmpty Text)
- name :: Text
- scope :: Scope
- id :: Text
- defaultAction :: DefaultAction
- visibilityConfig :: VisibilityConfig
- lockToken :: Text
}
newUpdateWebACL :: Text -> Scope -> Text -> DefaultAction -> VisibilityConfig -> Text -> UpdateWebACL
updateWebACL_captchaConfig :: Lens' UpdateWebACL (Maybe CaptchaConfig)
updateWebACL_challengeConfig :: Lens' UpdateWebACL (Maybe ChallengeConfig)
updateWebACL_customResponseBodies :: Lens' UpdateWebACL (Maybe (HashMap Text CustomResponseBody))
updateWebACL_description :: Lens' UpdateWebACL (Maybe Text)
updateWebACL_rules :: Lens' UpdateWebACL (Maybe [Rule])
updateWebACL_tokenDomains :: Lens' UpdateWebACL (Maybe (NonEmpty Text))
updateWebACL_name :: Lens' UpdateWebACL Text
updateWebACL_scope :: Lens' UpdateWebACL Scope
updateWebACL_id :: Lens' UpdateWebACL Text
updateWebACL_defaultAction :: Lens' UpdateWebACL DefaultAction
updateWebACL_visibilityConfig :: Lens' UpdateWebACL VisibilityConfig
updateWebACL_lockToken :: Lens' UpdateWebACL Text
data UpdateWebACLResponse = UpdateWebACLResponse' {
- nextLockToken :: Maybe Text
- httpStatus :: Int
}
newUpdateWebACLResponse :: Int -> UpdateWebACLResponse
updateWebACLResponse_nextLockToken :: Lens' UpdateWebACLResponse (Maybe Text)
updateWebACLResponse_httpStatus :: Lens' UpdateWebACLResponse Int

Creating a Request

data UpdateWebACL Source #

See: newUpdateWebACL smart constructor.

Constructors

UpdateWebACL'

Fields

captchaConfig :: Maybe CaptchaConfig
Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.
challengeConfig :: Maybe ChallengeConfig
Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.
customResponseBodies :: Maybe (HashMap Text CustomResponseBody)
A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.
For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.
For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.
description :: Maybe Text
A description of the web ACL that helps with identification.
rules :: Maybe [Rule]
The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.
tokenDomains :: Maybe (NonEmpty Text)
Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.
Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }
Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.
name :: Text
The name of the web ACL. You cannot change the name of a web ACL 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
The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
defaultAction :: DefaultAction
The action to perform if none of the Rules contained in the WebACL match.
visibilityConfig :: VisibilityConfig
Defines and enables Amazon CloudWatch metrics and web request sample collection.
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 UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods toJSON :: UpdateWebACL -> Value # toEncoding :: UpdateWebACL -> Encoding # toJSONList :: [UpdateWebACL] -> Value # toEncodingList :: [UpdateWebACL] -> Encoding #
ToHeaders UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods toHeaders :: UpdateWebACL -> [Header] #
ToPath UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods toPath :: UpdateWebACL -> ByteString #
ToQuery UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods toQuery :: UpdateWebACL -> QueryString #
AWSRequest UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Associated Types type AWSResponse UpdateWebACL # Methods request :: (Service -> Service) -> UpdateWebACL -> Request UpdateWebACL # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy UpdateWebACL -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse UpdateWebACL))) #
Generic UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Associated Types type Rep UpdateWebACL :: Type -> Type # Methods from :: UpdateWebACL -> Rep UpdateWebACL x # to :: Rep UpdateWebACL x -> UpdateWebACL #
Read UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods readsPrec :: Int -> ReadS UpdateWebACL # readList :: ReadS [UpdateWebACL] # readPrec :: ReadPrec UpdateWebACL # readListPrec :: ReadPrec [UpdateWebACL] #
Show UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods showsPrec :: Int -> UpdateWebACL -> ShowS # show :: UpdateWebACL -> String # showList :: [UpdateWebACL] -> ShowS #
NFData UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods rnf :: UpdateWebACL -> () #
Eq UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods (==) :: UpdateWebACL -> UpdateWebACL -> Bool # (/=) :: UpdateWebACL -> UpdateWebACL -> Bool #
Hashable UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL Methods hashWithSalt :: Int -> UpdateWebACL -> Int # hash :: UpdateWebACL -> Int #
type AWSResponse UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL type AWSResponse UpdateWebACL = UpdateWebACLResponse
type Rep UpdateWebACL Source #
Instance details Defined in Amazonka.WAFV2.UpdateWebACL type Rep UpdateWebACL = D1 ('MetaData "UpdateWebACL" "Amazonka.WAFV2.UpdateWebACL" "amazonka-wafv2-2.0-3v3WgpYn7RT5hSd6MsT5dN" 'False) (C1 ('MetaCons "UpdateWebACL'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "captchaConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe CaptchaConfig)) :: (S1 ('MetaSel ('Just "challengeConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe ChallengeConfig)) :: S1 ('MetaSel ('Just "customResponseBodies") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text CustomResponseBody))))) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "rules") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Rule])) :: S1 ('MetaSel ('Just "tokenDomains") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty 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 "defaultAction") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 DefaultAction) :: (S1 ('MetaSel ('Just "visibilityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 VisibilityConfig) :*: S1 ('MetaSel ('Just "lockToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newUpdateWebACL Source #

Arguments

:: Text	`UpdateWebACL`
-> Scope	`UpdateWebACL`
-> Text	`UpdateWebACL`
-> DefaultAction	`UpdateWebACL`
-> VisibilityConfig	`UpdateWebACL`
-> Text	`UpdateWebACL`
-> UpdateWebACL

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

UpdateWebACL, updateWebACL_captchaConfig - Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

UpdateWebACL, updateWebACL_challengeConfig - Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

UpdateWebACL, updateWebACL_customResponseBodies - A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

UpdateWebACL, updateWebACL_description - A description of the web ACL that helps with identification.

UpdateWebACL, updateWebACL_rules - The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

UpdateWebACL, updateWebACL_tokenDomains - Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

UpdateWebACL, updateWebACL_name - The name of the web ACL. You cannot change the name of a web ACL after you create it.

UpdateWebACL, updateWebACL_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.

UpdateWebACL, updateWebACL_id - The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

UpdateWebACL, updateWebACL_defaultAction - The action to perform if none of the Rules contained in the WebACL match.

UpdateWebACL, updateWebACL_visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample collection.

UpdateWebACL, updateWebACL_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

updateWebACL_captchaConfig :: Lens' UpdateWebACL (Maybe CaptchaConfig) Source #

Specifies how WAF should handle CAPTCHA evaluations for rules that don't have their own CaptchaConfig settings. If you don't specify this, WAF uses its default settings for CaptchaConfig.

updateWebACL_challengeConfig :: Lens' UpdateWebACL (Maybe ChallengeConfig) Source #

Specifies how WAF should handle challenge evaluations for rules that don't have their own ChallengeConfig settings. If you don't specify this, WAF uses its default settings for ChallengeConfig.

updateWebACL_customResponseBodies :: Lens' UpdateWebACL (Maybe (HashMap Text CustomResponseBody)) Source #

A map of custom response keys and content bodies. When you create a rule with a block action, you can send a custom response to the web request. You define these for the web ACL, and then use them in the rules and default actions that you define in the web ACL.

For information about customizing web requests and responses, see Customizing web requests and responses in WAF in the WAF Developer Guide.

For information about the limits on count and size for custom request and response settings, see WAF quotas in the WAF Developer Guide.

updateWebACL_description :: Lens' UpdateWebACL (Maybe Text) Source #

A description of the web ACL that helps with identification.

updateWebACL_rules :: Lens' UpdateWebACL (Maybe [Rule]) Source #

The Rule statements used to identify the web requests that you want to allow, block, or count. Each rule includes one top-level statement that WAF uses to identify matching web requests, and parameters that govern how WAF handles them.

updateWebACL_tokenDomains :: Lens' UpdateWebACL (Maybe (NonEmpty Text)) Source #

Specifies the domains that WAF should accept in a web request token. This enables the use of tokens across multiple protected websites. When WAF provides a token, it uses the domain of the Amazon Web Services resource that the web ACL is protecting. If you don't specify a list of token domains, WAF accepts tokens only for the domain of the protected resource. With a token domain list, WAF accepts the resource's host domain plus all domains in the token domain list, including their prefixed subdomains.

Example JSON: "TokenDomains": { "mywebsite.com", "myotherwebsite.com" }

Public suffixes aren't allowed. For example, you can't use usa.gov or co.uk as token domains.

updateWebACL_name :: Lens' UpdateWebACL Text Source #

The name of the web ACL. You cannot change the name of a web ACL after you create it.

updateWebACL_scope :: Lens' UpdateWebACL 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.

updateWebACL_id :: Lens' UpdateWebACL Text Source #

The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

updateWebACL_defaultAction :: Lens' UpdateWebACL DefaultAction Source #

The action to perform if none of the Rules contained in the WebACL match.

updateWebACL_visibilityConfig :: Lens' UpdateWebACL VisibilityConfig Source #

Defines and enables Amazon CloudWatch metrics and web request sample collection.

updateWebACL_lockToken :: Lens' UpdateWebACL 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 UpdateWebACLResponse Source #

See: newUpdateWebACLResponse smart constructor.

Constructors

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

newUpdateWebACLResponse Source #

Arguments

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

Create a value of UpdateWebACLResponse 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:UpdateWebACLResponse', updateWebACLResponse_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:UpdateWebACLResponse', updateWebACLResponse_httpStatus - The response's http status code.

Response Lenses

updateWebACLResponse_nextLockToken :: Lens' UpdateWebACLResponse (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.

updateWebACLResponse_httpStatus :: Lens' UpdateWebACLResponse Int Source #

The response's http status code.