AWS::NetworkFirewall::RuleGroupCfnRuleGroup
Use the [](https://docs.aws.amazon.com/RuleGroup) to define a reusable collection of stateless or stateful network traffic filtering rules. You use rule groups in an firewall policy to specify the filtering behavior of an firewall.
Import
import { CfnRuleGroup } from 'aws-cdk-lib/aws-networkfirewall';Or use the module namespace:
import * as networkfirewall from 'aws-cdk-lib/aws-networkfirewall';
// networkfirewall.CfnRuleGroupProperties
Configuration passed to the constructor as CfnRuleGroupProps.
capacityRequirednumberThe maximum operating resources that this rule group can use. You can't change a rule group's capacity setting after you create the rule group. 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.
ruleGroupNameRequiredstringThe descriptive name of the rule group. You can't change the name of a rule group after you create it.
typeRequiredstringIndicates 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.
descriptionOptionalstringA description of the rule group.
ruleGroupOptionalIResolvable | RuleGroupPropertyAn object that defines the rule group rules.
summaryConfigurationOptionalIResolvable | SummaryConfigurationPropertyA complex type containing the currently selected rule option fields that will be displayed for rule summarization returned by `DescribeRuleGroupSummary` . - The `RuleOptions` specified in `SummaryConfiguration` - Rule metadata organization preferences
tagsOptionalCfnTag[]An array of key-value pairs to apply to this resource. For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) .
CloudFormation Resource
This L1 construct maps directly to the following CloudFormation resource type.
Learn AWS the Practical Way
Our bi-weekly newsletter teaches hands-on AWS fundamentals. No certification fluff - just practical knowledge.
Subscribe to NewsletterQuick Facts
aws-networkfirewallAWS::NetworkFirewall::RuleGroup