Class: Aws::WAFV2::Types::WebACLSummary

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

This is the latest version of AWS WAF, named AWS WAFV2, released in November, 2019. For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF Developer Guide.

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.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String)


9175
9176
9177
9178
9179
9180
9181
9182
9183
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9175

class WebACLSummary < Struct.new(
  :name,
  :id,
  :description,
  :lock_token,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the Web ACL that helps with identification. You cannot change the description of a Web ACL after you create it.

Returns:

  • (String)


9175
9176
9177
9178
9179
9180
9181
9182
9183
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9175

class WebACLSummary < Struct.new(
  :name,
  :id,
  :description,
  :lock_token,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#idString

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.

Returns:

  • (String)


9175
9176
9177
9178
9179
9180
9181
9182
9183
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9175

class WebACLSummary < Struct.new(
  :name,
  :id,
  :description,
  :lock_token,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#lock_tokenString

A token used for optimistic locking. AWS 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. 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 a WAFOptimisticLockException. If this happens, perform another get, and use the new token returned by that operation.

Returns:

  • (String)


9175
9176
9177
9178
9179
9180
9181
9182
9183
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9175

class WebACLSummary < Struct.new(
  :name,
  :id,
  :description,
  :lock_token,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the Web ACL. You cannot change the name of a Web ACL after you create it.

Returns:

  • (String)


9175
9176
9177
9178
9179
9180
9181
9182
9183
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 9175

class WebACLSummary < Struct.new(
  :name,
  :id,
  :description,
  :lock_token,
  :arn)
  SENSITIVE = []
  include Aws::Structure
end