Method: Aws::WAFRegional::Client#delete_rule_group

Defined in:
lib/aws-sdk-wafregional/client.rb

#delete_rule_group(params = {}) ⇒ Types::DeleteRuleGroupResponse

<note markdown=“1”> This is **AWS WAF Classic** documentation. For more information, see

AWS WAF Classic][1

in the developer guide.

**For the latest version of AWS WAF**, use the AWS WAFV2 API and see

the [AWS WAF Developer Guide]. With the latest version, AWS WAF has a single set of endpoints for regional and global use.

</note>

Permanently deletes a RuleGroup. You can’t delete a ‘RuleGroup` if it’s still used in any ‘WebACL` objects or if it still includes any rules.

If you just want to remove a ‘RuleGroup` from a `WebACL`, use UpdateWebACL.

To permanently delete a ‘RuleGroup` from AWS WAF, perform the following steps:

  1. Update the ‘RuleGroup` to remove rules, if any. For more information, see UpdateRuleGroup.

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

  3. Submit a ‘DeleteRuleGroup` request.

[1]: docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html [2]: docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html

Examples:

Request syntax with placeholder values


resp = client.delete_rule_group({
  rule_group_id: "ResourceId", # required
  change_token: "ChangeToken", # required
})

Response structure


resp.change_token #=> String

Parameters:

  • params (Hash) (defaults to: {}) —

    ({})

Options Hash (params):

  • :rule_group_id (required, String) —

    The ‘RuleGroupId` of the RuleGroup that you want to delete. `RuleGroupId` is returned by CreateRuleGroup and by ListRuleGroups.

  • :change_token (required, String) —

    The value returned by the most recent call to GetChangeToken.

Returns:

See Also:



2464
2465
2466
2467
 
# File 'lib/aws-sdk-wafregional/client.rb', line 2464

def delete_rule_group(params = {}, options = {})
  req = build_request(:delete_rule_group, params)
  req.send_request(options)
end