Class: Aws::WAFV2::Types::IPSetSummary

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

Overview

High-level information about an IPSet, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage an ‘IPSet`, and the ARN, that you provide to the IPSetReferenceStatement to use the address set in a Rule.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String) 


3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/aws-sdk-wafv2/types.rb', line 3994

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

#description ⇒ String

A description of the IP set that helps with identification.

Returns:

  • (String) 


3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/aws-sdk-wafv2/types.rb', line 3994

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

#id ⇒ String

A unique identifier for the set. This ID is returned in the responses to create and list commands. You provide it to operations like update and delete.

Returns:

  • (String) 


3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/aws-sdk-wafv2/types.rb', line 3994

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

#lock_token ⇒ String

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.

Returns:

  • (String) 


3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/aws-sdk-wafv2/types.rb', line 3994

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

#name ⇒ String

The name of the IP set. You cannot change the name of an ‘IPSet` after you create it.

Returns:

  • (String) 


3994
3995
3996
3997
3998
3999
4000
4001
4002
 
# File 'lib/aws-sdk-wafv2/types.rb', line 3994

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