Class: Aws::NetworkFirewall::Types::RuleMetadata

Inherits:

Struct

Object
Struct
Aws::NetworkFirewall::Types::RuleMetadata

show all

Defined in:: gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

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.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#rule_description ⇒ String
A description of the rule, up to 512 characters.
#rule_enabled ⇒ Boolean
Specifies whether the rule is active.

Instance Attribute Details

#rule_description ⇒ `String`

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.

Returns:

(String)

# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 8465

class RuleMetadata < Struct.new(
  :rule_enabled,
  :rule_description)
  SENSITIVE = []
  include Aws::Structure
end

#rule_enabled ⇒ `Boolean`

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.