Class: AWSCDK::NetworkFirewall::CfnRuleGroup::TCPFlagFieldProperty

Inherits:

Jsii::Struct

• Object
• Jsii::Struct
• AWSCDK::NetworkFirewall::CfnRuleGroup::TCPFlagFieldProperty

Defined in:

network_firewall/cfn_rule_group.rb

Overview

TCP flags and masks to inspect packets for. This is used in the match attributes specification.

For example:

"TCPFlags": [ { "Flags": [ "ECE", "SYN" ], "Masks": [ "SYN", "ECE" ] } ]

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html

Instance Attribute Summary

• #flags ⇒ Array<String> readonly

  Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match.

• #masks ⇒ Array<String>^? readonly

  The set of flags to consider in the inspection.

Class Method Summary

• .jsii_properties ⇒ Object

Instance Method Summary

• #initialize(flags:, masks: nil) ⇒ TCPFlagFieldProperty constructor

  A new instance of TCPFlagFieldProperty.

• #to_jsii ⇒ Object

Constructor Details

#initialize(flags:, masks: nil) ⇒ TCPFlagFieldProperty

Returns a new instance of TCPFlagFieldProperty.

Parameters:

• flags (Array<String>) —

  Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match.

• masks (Array<String>, nil) (defaults to: nil) —

  The set of flags to consider in the inspection.

# File 'network_firewall/cfn_rule_group.rb', line 1829

def initialize(flags:, masks: nil)
  @flags = flags
  Jsii::Type.check_type(@flags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "flags")
  @masks = masks
  Jsii::Type.check_type(@masks, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "masks") unless @masks.nil?
end

Instance Attribute Details

#flags ⇒ Array<String> (readonly)

Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match.

This setting can only specify values that are also specified in the Masks setting.

For the flags that are specified in the masks setting, the following must be true for the packet to match:

• The ones that are set in this flags setting must be set in the packet.
• The ones that are not set in this flags setting must also not be set in the packet.

Returns:

• (Array<String>)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-flags

# File 'network_firewall/cfn_rule_group.rb', line 1847

def flags
  @flags
end

#masks ⇒ Array<String>^? (readonly)

The set of flags to consider in the inspection.

To inspect all flags in the valid values list, leave this with no setting.

Returns:

• (Array<String>, nil)

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-masks

# File 'network_firewall/cfn_rule_group.rb', line 1854

def masks
  @masks
end

Class Method Details

.jsii_properties ⇒ Object

# File 'network_firewall/cfn_rule_group.rb', line 1856

def self.jsii_properties
  {
    :flags => "flags",
    :masks => "masks",
  }
end

Instance Method Details

#to_jsii ⇒ Object

# File 'network_firewall/cfn_rule_group.rb', line 1863

def to_jsii
  result = {}
  result.merge!({
    "flags" => @flags,
    "masks" => @masks,
  })
  result.compact
end