Package software.amazon.awscdk.services.networkfirewall

Interface CfnRuleGroup.TCPFlagFieldProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnRuleGroup.TCPFlagFieldProperty.Jsii$Proxy

Enclosing class:

CfnRuleGroup

@Stability(Stable)
public static interface CfnRuleGroup.TCPFlagFieldProperty
extends software.amazon.jsii.JsiiSerializable

TCP flags and masks to inspect packets for. This is used in the RuleGroup.MatchAttributes specification.

For example:

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

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkfirewall.*;
 TCPFlagFieldProperty tCPFlagFieldProperty = TCPFlagFieldProperty.builder()
         .flags(List.of("flags"))
         // the properties below are optional
         .masks(List.of("masks"))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnRuleGroup.TCPFlagFieldProperty.Builder	A builder for CfnRuleGroup.TCPFlagFieldProperty
static final class	CfnRuleGroup.TCPFlagFieldProperty.Jsii$Proxy	An implementation for CfnRuleGroup.TCPFlagFieldProperty

Method Summary

Modifier and Type	Method	Description
static CfnRuleGroup.TCPFlagFieldProperty.Builder	builder()
List<String>	getFlags()	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.
default List<String>	getMasks()	The set of flags to consider in the inspection.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFlags

@Stability(Stable)
@NotNull
List<String> getFlags()

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.

See Also:

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

getMasks

@Stability(Stable)
@Nullable
default List<String> getMasks()

The set of flags to consider in the inspection.

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

See Also:

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

builder

@Stability(Stable)
static CfnRuleGroup.TCPFlagFieldProperty.Builder builder()

Returns:

a CfnRuleGroup.TCPFlagFieldProperty.Builder of CfnRuleGroup.TCPFlagFieldProperty