WebACLSummary
High-level information about a WebACL, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a WebACL
, and the ARN, that you provide to operations like AssociateWebACL.
Contents
- ARN
-
The Amazon Resource Name (ARN) of the entity.
Type: String
Length Constraints: Minimum length of 20. Maximum length of 2048.
Pattern:
.*\S.*
Required: No
- Description
-
A description of the web ACL that helps with identification.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\w+=:#@/\-,\.][\w+=:#@/\-,\.\s]+[\w+=:#@/\-,\.]$
Required: No
- Id
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
Required: No
- LockToken
-
A token used for optimistic locking. AWS WAF returns a token to your
get
andlist
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 likeupdate
anddelete
. AWS 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 aWAFOptimisticLockException
. If this happens, perform anotherget
, and use the new token returned by that operation.Type: String
Length Constraints: Minimum length of 1. Maximum length of 36.
Pattern:
^[0-9a-f]{8}-(?:[0-9a-f]{4}-){3}[0-9a-f]{12}$
Required: No
- Name
-
The name of the web ACL. You cannot change the name of a web ACL after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[\w\-]+$
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: