| 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.UpdateRuleGroup
Description
Updates the specified RuleGroup.
This operation completely replaces the mutable specifications that you already have for the rule group with the ones that you provide to this call. To modify the rule group, retrieve it by calling GetRuleGroup, update the settings as needed, and then provide the complete rule group 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.
A rule group defines a collection of rules to inspect and control web requests that you can use in a WebACL. When you create a rule group, you define an immutable capacity limit. If you update a rule group, you must stay within the capacity. This allows others to reuse the rule group with confidence in its capacity requirements.
Synopsis
- data UpdateRuleGroup = UpdateRuleGroup' {
- customResponseBodies :: Maybe (HashMap Text CustomResponseBody)
- description :: Maybe Text
- rules :: Maybe [Rule]
- name :: Text
- scope :: Scope
- id :: Text
- visibilityConfig :: VisibilityConfig
- lockToken :: Text
- newUpdateRuleGroup :: Text -> Scope -> Text -> VisibilityConfig -> Text -> UpdateRuleGroup
- updateRuleGroup_customResponseBodies :: Lens' UpdateRuleGroup (Maybe (HashMap Text CustomResponseBody))
- updateRuleGroup_description :: Lens' UpdateRuleGroup (Maybe Text)
- updateRuleGroup_rules :: Lens' UpdateRuleGroup (Maybe [Rule])
- updateRuleGroup_name :: Lens' UpdateRuleGroup Text
- updateRuleGroup_scope :: Lens' UpdateRuleGroup Scope
- updateRuleGroup_id :: Lens' UpdateRuleGroup Text
- updateRuleGroup_visibilityConfig :: Lens' UpdateRuleGroup VisibilityConfig
- updateRuleGroup_lockToken :: Lens' UpdateRuleGroup Text
- data UpdateRuleGroupResponse = UpdateRuleGroupResponse' {
- nextLockToken :: Maybe Text
- httpStatus :: Int
- newUpdateRuleGroupResponse :: Int -> UpdateRuleGroupResponse
- updateRuleGroupResponse_nextLockToken :: Lens' UpdateRuleGroupResponse (Maybe Text)
- updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int
Creating a Request
data UpdateRuleGroup Source #
See: newUpdateRuleGroup smart constructor.
Constructors
| UpdateRuleGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Scope | |
| -> Text | |
| -> VisibilityConfig | |
| -> Text | |
| -> UpdateRuleGroup |
Create a value of UpdateRuleGroup 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:
UpdateRuleGroup, updateRuleGroup_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 rule group, and then use them in the rules that
you define in the rule group.
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.
UpdateRuleGroup, updateRuleGroup_description - A description of the rule group that helps with identification.
UpdateRuleGroup, updateRuleGroup_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.
UpdateRuleGroup, updateRuleGroup_name - The name of the rule group. You cannot change the name of a rule group
after you create it.
UpdateRuleGroup, updateRuleGroup_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.
UpdateRuleGroup, updateRuleGroup_id - A unique identifier for the rule group. This ID is returned in the
responses to create and list commands. You provide it to operations like
update and delete.
UpdateRuleGroup, updateRuleGroup_visibilityConfig - Defines and enables Amazon CloudWatch metrics and web request sample
collection.
UpdateRuleGroup, updateRuleGroup_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
updateRuleGroup_customResponseBodies :: Lens' UpdateRuleGroup (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 rule group, and then use them in the rules that you define in the rule group.
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.
updateRuleGroup_description :: Lens' UpdateRuleGroup (Maybe Text) Source #
A description of the rule group that helps with identification.
updateRuleGroup_rules :: Lens' UpdateRuleGroup (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.
updateRuleGroup_name :: Lens' UpdateRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
updateRuleGroup_scope :: Lens' UpdateRuleGroup 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.
updateRuleGroup_id :: Lens' UpdateRuleGroup Text Source #
A unique identifier for the rule group. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
updateRuleGroup_visibilityConfig :: Lens' UpdateRuleGroup VisibilityConfig Source #
Defines and enables Amazon CloudWatch metrics and web request sample collection.
updateRuleGroup_lockToken :: Lens' UpdateRuleGroup 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 UpdateRuleGroupResponse Source #
See: newUpdateRuleGroupResponse smart constructor.
Constructors
| UpdateRuleGroupResponse' | |
Fields
| |
Instances
newUpdateRuleGroupResponse Source #
Create a value of UpdateRuleGroupResponse 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:UpdateRuleGroupResponse', updateRuleGroupResponse_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:UpdateRuleGroupResponse', updateRuleGroupResponse_httpStatus - The response's http status code.
Response Lenses
updateRuleGroupResponse_nextLockToken :: Lens' UpdateRuleGroupResponse (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.
updateRuleGroupResponse_httpStatus :: Lens' UpdateRuleGroupResponse Int Source #
The response's http status code.