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

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#available_labelsArray<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:



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#capacityInteger

The web ACL capacity units (WCUs) required for this rule group. WAF uses web ACL capacity units (WCU) 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 each rule's relative cost. Rule group capacity is fixed at creation, so users can plan their web ACL WCU usage when they use a rule group. The WCU limit for web ACLs is 1,500.

Returns:

  • (Integer)


3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#consumed_labelsArray<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:



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#label_namespaceString

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)


3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#rulesArray<Types::RuleSummary>

Returns:



3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#sns_topic_arnString

The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record 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.

Returns:

  • (String)


3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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

#version_nameString

The managed rule group's version.

Returns:

  • (String)


3966
3967
3968
3969
3970
3971
3972
3973
3974
3975
3976
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 3966

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