paws.security.identity (version 0.1.0)

waf_delete_rule: Permanently deletes a Rule

Description

Permanently deletes a Rule. You can't delete a Rule if it's still used in any WebACL objects or if it still includes any predicates, such as ByteMatchSet objects.

Usage

waf_delete_rule(RuleId, ChangeToken)

Arguments

RuleId

[required] The RuleId of the Rule that you want to delete. RuleId is returned by CreateRule and by ListRules.

ChangeToken

[required] The value returned by the most recent call to GetChangeToken.

Request syntax

svc$delete_rule(
  RuleId = "string",
  ChangeToken = "string"
)

Details

If you just want to remove a Rule from a WebACL, use UpdateWebACL.

To permanently delete a Rule from AWS WAF, perform the following steps:

1. Update the Rule to remove predicates, if any. For more information, see UpdateRule.

2. Use GetChangeToken to get the change token that you provide in the ChangeToken parameter of a DeleteRule request.

3. Submit a DeleteRule request.

Examples

# NOT RUN {
# The following example deletes a rule with the ID WAFRule-1-Example.
# }
# NOT RUN {
svc$delete_rule(
  ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
  RuleId = "WAFRule-1-Example"
)
# }
# NOT RUN {
# }