Class: Aws::WAFV2::Types::DescribeManagedRuleGroupResponse

Inherits:

Struct

• Object
• Struct
• Aws::WAFV2::Types::DescribeManagedRuleGroupResponse

Includes:

Structure

Defined in:

lib/aws-sdk-wafv2/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #available_labels ⇒ Array<Types::LabelSummary>

  The labels that one or more rules in this rule group add to matching web requests.

• #capacity ⇒ Integer

  The web ACL capacity units (WCUs) required for this rule group.

• #consumed_labels ⇒ Array<Types::LabelSummary>

  The labels that one or more rules in this rule group match against in label match statements.

• #label_namespace ⇒ String

  The label namespace prefix for this rule group.

• #rules ⇒ Array<Types::RuleSummary>
• #sns_topic_arn ⇒ String

  The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to provide notification of changes to the managed rule group.

• #version_name ⇒ String

  The managed rule group’s version.

Instance Attribute Details

#available_labels ⇒ Array<Types::LabelSummary>

The labels that one or more rules in this rule group add to matching web requests. These labels are defined in the ‘RuleLabels` for a Rule.

Returns:

• (Array<Types::LabelSummary>)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#capacity ⇒ Integer

The web ACL capacity units (WCUs) required for this rule group.

WAF uses WCUs to calculate and control the operating resources that are used to run your rules, rule groups, and web ACLs. WAF calculates capacity differently for each rule type, to reflect the relative cost of each rule. Simple rules that cost little to run use fewer WCUs than more complex rules that use more processing power. Rule group capacity is fixed at creation, which helps users plan their web ACL WCU usage when they use a rule group. For more information, see [WAF web ACL capacity units (WCU)] in the *WAF Developer Guide*.

[1]: docs.aws.amazon.com/waf/latest/developerguide/aws-waf-capacity-units.html

Returns:

• (Integer)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#consumed_labels ⇒ Array<Types::LabelSummary>

The labels that one or more rules in this rule group match against in label match statements. These labels are defined in a ‘LabelMatchStatement` specification, in the Statement definition of a rule.

Returns:

• (Array<Types::LabelSummary>)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#label_namespace ⇒ String

The label namespace prefix for this rule group. All labels added by rules in this 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>`

Returns:

• (String)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#rules ⇒ Array<Types::RuleSummary>

Returns:

• (Array<Types::RuleSummary>)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#sns_topic_arn ⇒ String

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that’s used to provide notification of changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the [Amazon Simple Notification Service Developer Guide].

[1]: docs.aws.amazon.com/sns/latest/dg/welcome.html

Returns:

• (String)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end

#version_name ⇒ String

The managed rule group’s version.

Returns:

• (String)

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

class DescribeManagedRuleGroupResponse < Struct.new(
  :version_name,
  :sns_topic_arn,
  :capacity,
  :rules,
  :label_namespace,
  :available_labels,
  :consumed_labels)
  SENSITIVE = []
  include Aws::Structure
end