rule_group_summaries

Creates, updates, deletes, gets or lists a rule_group_summaries resource.

Overview

Name	rule_group_summaries
Type	Resource
Id	aws.network_firewall.rule_group_summaries

Fields

The following fields are returned by SELECT queries:

describe_rule_group_summary

Name	Datatype	Description
description	string	A description of the rule group. (pattern: <code>^.*$</code>)
rule_group_name	string	The descriptive name of the rule group. You can't change the name of a rule group after you create it. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
summary	object	A complex type that contains rule information based on the rule group's configured summary settings. The content varies depending on the fields that you specified to extract in your SummaryConfiguration. When you haven't configured any summary settings, this returns an empty array. The response might include: Rule identifiers Rule descriptions Any metadata fields that you specified in your SummaryConfiguration

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_rule_group_summary	select	region		Returns detailed information for a stateful rule group. For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups. To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

SELECT examples

describe_rule_group_summary

Returns detailed information for a stateful rule group. For active threat defense Amazon Web Services managed rule groups, this operation provides insight into the protections enabled by the rule group, based on Suricata rule metadata fields. Summaries are available for rule groups you manage and for active threat defense Amazon Web Services managed rule groups. To modify how threat information appears in summaries, use the SummaryConfiguration parameter in UpdateRuleGroup.

SELECT
description,
rule_group_name,
summary
FROM aws.network_firewall.rule_group_summaries
WHERE region = '{{ region }}' -- required
;