Class: Aws::WAFV2::Types::ManagedRuleSetSummary
- Inherits:
-
Struct
- Object
- Struct
- Aws::WAFV2::Types::ManagedRuleSetSummary
- Defined in:
- gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb
Overview
High-level information for a managed rule set.
Vendors, you can use the managed rule set APIs to provide controlled
rollout of your versioned managed rule group offerings for your
customers. The APIs are ListManagedRuleSets
, GetManagedRuleSet
,
PutManagedRuleSetVersions
, and
UpdateManagedRuleSetVersionExpiryDate
.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#arn ⇒ String
The Amazon Resource Name (ARN) of the entity.
-
#description ⇒ String
A description of the set that helps with identification.
-
#id ⇒ String
A unique identifier for the managed rule set.
-
#label_namespace ⇒ String
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
-
#lock_token ⇒ String
A token used for optimistic locking.
-
#name ⇒ String
The name of the managed rule set.
Instance Attribute Details
#arn ⇒ String
The Amazon Resource Name (ARN) of the entity.
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
A description of the set that helps with identification.
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) SENSITIVE = [] include Aws::Structure end |
#id ⇒ String
A unique identifier for the managed rule set. The ID is returned in
the responses to commands like list
. You provide it to operations
like get
and update
.
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) SENSITIVE = [] include Aws::Structure end |
#label_namespace ⇒ String
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.
The syntax for the label namespace prefix for a managed rule group is the following:
awswaf:managed:<vendor>:<rule group name>
:When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:
<label namespace>:<label from rule>
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) 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.
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) SENSITIVE = [] include Aws::Structure end |
#name ⇒ String
The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
5754 5755 5756 5757 5758 5759 5760 5761 5762 5763 |
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5754 class ManagedRuleSetSummary < Struct.new( :name, :id, :description, :lock_token, :arn, :label_namespace) SENSITIVE = [] include Aws::Structure end |