rule_group_metadatas

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

Overview

Name	rule_group_metadatas
Type	Resource
Id	aws.network_firewall.rule_group_metadatas

Fields

The following fields are returned by SELECT queries:

describe_rule_group_metadata

Name	Datatype	Description
capacity	integer	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. You can retrieve the capacity that would be required for a rule group before you create the rule group by calling CreateRuleGroup with DryRun set to TRUE.
description	string	Returns the metadata objects for the specified rule group. (pattern: <code>^.*$</code>)
last_modified_time	string (date-time)	A timestamp indicating when the rule group was last modified.
listing_name	string	The display name of the product listing for this rule group.
product_id	string	The unique identifier for the product listing associated with this rule group.
rule_group_arn	string	The descriptive name of the rule group. You can't change the name of a rule group after you create it. You must specify the ARN or the name, and you can specify both. (pattern: <code>^arn:aws.*</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. You must specify the ARN or the name, and you can specify both. (pattern: <code>^[a-zA-Z0-9-]+$</code>)
stateful_rule_options	object	Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
type	string	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. This setting is required for requests that do not include the RuleGroupARN. (STATELESS, STATEFUL, STATEFUL_DOMAIN)
vendor_name	string	The name of the Amazon Web Services Marketplace vendor that provides this rule group.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_rule_group_metadata	select	region		High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

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_metadata

High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.

SELECT
capacity,
description,
last_modified_time,
listing_name,
product_id,
rule_group_arn,
rule_group_name,
stateful_rule_options,
type,
vendor_name
FROM aws.network_firewall.rule_group_metadatas
WHERE region = '{{ region }}' -- required
;