RuleGroupResponse
The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Types
Properties
The list of analysis results for AnalyzeRuleGroup
. If you set AnalyzeRuleGroup
to TRUE
in CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup, Network Firewall analyzes the rule group and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in the list of analysis results.
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
The number of capacity units currently consumed by the rule group rules.
A description of the rule group.
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
The last time that the rule group was changed.
The number of firewall policies that use this rule group.
The Amazon Resource Name (ARN) of the rule group.
The unique identifier for the rule group.
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
Detailed information about the current status of a rule group.
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..
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
A complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by DescribeRuleGroupSummary.
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.