| 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.DeleteRuleGroup
Description
Deletes the specified RuleGroup.
Synopsis
- data DeleteRuleGroup = DeleteRuleGroup' {}
- newDeleteRuleGroup :: Text -> Scope -> Text -> Text -> DeleteRuleGroup
- deleteRuleGroup_name :: Lens' DeleteRuleGroup Text
- deleteRuleGroup_scope :: Lens' DeleteRuleGroup Scope
- deleteRuleGroup_id :: Lens' DeleteRuleGroup Text
- deleteRuleGroup_lockToken :: Lens' DeleteRuleGroup Text
- data DeleteRuleGroupResponse = DeleteRuleGroupResponse' {
- httpStatus :: Int
- newDeleteRuleGroupResponse :: Int -> DeleteRuleGroupResponse
- deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int
Creating a Request
data DeleteRuleGroup Source #
See: newDeleteRuleGroup smart constructor.
Constructors
| DeleteRuleGroup' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> Scope | |
| -> Text | |
| -> Text | |
| -> DeleteRuleGroup |
Create a value of DeleteRuleGroup 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:
DeleteRuleGroup, deleteRuleGroup_name - The name of the rule group. You cannot change the name of a rule group
after you create it.
DeleteRuleGroup, deleteRuleGroup_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.
DeleteRuleGroup, deleteRuleGroup_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.
DeleteRuleGroup, deleteRuleGroup_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
deleteRuleGroup_name :: Lens' DeleteRuleGroup Text Source #
The name of the rule group. You cannot change the name of a rule group after you create it.
deleteRuleGroup_scope :: Lens' DeleteRuleGroup 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.
deleteRuleGroup_id :: Lens' DeleteRuleGroup 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.
deleteRuleGroup_lockToken :: Lens' DeleteRuleGroup 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 DeleteRuleGroupResponse Source #
See: newDeleteRuleGroupResponse smart constructor.
Constructors
| DeleteRuleGroupResponse' | |
Fields
| |
Instances
newDeleteRuleGroupResponse Source #
Create a value of DeleteRuleGroupResponse 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:httpStatus:DeleteRuleGroupResponse', deleteRuleGroupResponse_httpStatus - The response's http status code.
Response Lenses
deleteRuleGroupResponse_httpStatus :: Lens' DeleteRuleGroupResponse Int Source #
The response's http status code.