Class: Aws::WAFV2::Types::RuleGroupSummary

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::RuleGroupSummary

Defined in:

gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

High-level information about a RuleGroup, returned by operations like create and list. This provides information like the ID, that you can use to retrieve and manage a RuleGroup, and the ARN, that you provide to the RuleGroupReferenceStatement to use the rule group in a Rule.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #arn ⇒ String

  The Amazon Resource Name (ARN) of the entity.

• #description ⇒ String

  A description of the rule group that helps with identification.

• #id ⇒ String

  A unique identifier for the rule group.

• #lock_token ⇒ String

  A token used for optimistic locking.

• #name ⇒ String

  The name of the data type instance.

Instance Attribute Details

#arn ⇒ String

The Amazon Resource Name (ARN) of the entity.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 7821

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

#description ⇒ String

A description of the rule group that helps with identification.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 7821

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

#id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 7821

class RuleGroupSummary < 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)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 7821

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

#name ⇒ String

The name of the data type instance. You cannot change the name after you create the instance.

Returns:

• (String)

# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 7821

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