Skip to content

Delete Web Acl

wafv2_delete_web_acl R Documentation

Deletes the specified WebACL

Description

Deletes the specified WebACL.

You can only use this if ManagedByFirewallManager is false in the web ACL.

Before deleting any web ACL, first disassociate it from all resources.

  • To retrieve a list of the resources that are associated with a web ACL, use the following calls:

    • For Amazon CloudFront distributions, use the CloudFront call ListDistributionsByWebACLId. For information, see ListDistributionsByWebACLId in the Amazon CloudFront API Reference.

    • For all other resources, call list_resources_for_web_acl.

  • To disassociate a resource from a web ACL, use the following calls:

    • For Amazon CloudFront distributions, provide an empty web ACL ID in the CloudFront call UpdateDistribution. For information, see UpdateDistribution in the Amazon CloudFront API Reference.

    • For all other resources, call disassociate_web_acl.

Usage

wafv2_delete_web_acl(Name, Scope, Id, LockToken)

Arguments

Name

[required] The name of the web ACL. You cannot change the name of a web ACL after you create it.
Scope

[required] Specifies whether this is for a global resource type, such as a Amazon CloudFront distribution.

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.
Id

[required] The unique identifier for the web ACL. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.
LockToken

[required] 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.

Value

An empty list.

Request syntax

svc$delete_web_acl(
  Name = "string",
  Scope = "CLOUDFRONT"|"REGIONAL",
  Id = "string",
  LockToken = "string"
)