RuleMetadata

Metadata for a single firewall engine rule. Use it to disable a rule without removing it and to attach a description. When you describe a rule group in RULES_STRING format, Network Firewall renders a disabled rule and its description as # comment lines above the rule.

RuleDescription

A description of the rule, up to 512 characters. The description can span multiple lines. A description line can't itself look like a firewall rule; to disable a rule, set RuleEnabled to FALSE instead.

Type: String

Length Constraints: Maximum length of 512.

Pattern: [\s\S]*

Required: No

RuleEnabled

Specifies whether the rule is active. The default is TRUE. When you set this to FALSE, Network Firewall keeps the rule in the rule group but doesn't evaluate it against traffic and doesn't count it toward the rule group's consumed capacity.

Type: Boolean

Required: No

RuleMetadata

Contents

See Also