AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the DeleteRule operation.

This is AWS WAF Classic documentation. For more information, see AWS WAF Classic 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.

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.

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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.WAF.AmazonWAFRequest
      Amazon.WAF.Model.DeleteRuleRequest

Namespace: Amazon.WAF.Model
Assembly: AWSSDK.WAF.dll
Version: 3.x.y.z

Syntax

C# 
public class DeleteRuleRequest : AmazonWAFRequest
         IAmazonWebServiceRequest

The DeleteRuleRequest type exposes the following members

Constructors

NameDescription
Public Method DeleteRuleRequest()

Properties

NameTypeDescription
Public Property ChangeToken System.String

Gets and sets the property ChangeToken.

The value returned by the most recent call to GetChangeToken.

Public Property RuleId System.String

Gets and sets the property RuleId.

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

Examples

The following example deletes a rule with the ID WAFRule-1-Example.

To delete a rule


var client = new AmazonWAFClient();
var response = client.DeleteRule(new DeleteRuleRequest 
{
    ChangeToken = "abcd12f2-46da-4fdb-b8d5-fbd4c466928f",
    RuleId = "WAFRule-1-Example"
});

string changeToken = response.ChangeToken;

Version Information

.NET Core App:
Supported in: 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5, 4.0, 3.5