You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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

Returned by:

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the entity.

#description ⇒ String

A description of the IP set that helps with identification. You cannot change the description of an IP set after you create it.

Returns:

  • (String) —

    A description of the IP set that helps with identification.

#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) —

    A unique identifier for the set.

#lock_token ⇒ String

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) —

    A token used for optimistic locking.

#name ⇒ String

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

Returns:

  • (String) —

    The name of the IP set.