Package software.amazon.awscdk.cfnpropertymixins.services.networkfirewall

Class CfnRuleGroupPropsMixin

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.Mixin

software.amazon.awscdk.cfnpropertymixins.services.networkfirewall.CfnRuleGroupPropsMixin

All Implemented Interfaces:

software.amazon.jsii.JsiiSerializable, software.constructs.IMixin

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-11T13:20:01.813Z")
@Stability(Stable)
public class CfnRuleGroupPropsMixin
extends Mixin
implements software.constructs.IMixin

Use the 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.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.networkfirewall.*;
 import software.amazon.awscdk.*;
 IMergeStrategy mergeStrategy;
 CfnRuleGroupPropsMixin cfnRuleGroupPropsMixin = CfnRuleGroupPropsMixin.Builder.create(CfnRuleGroupMixinProps.builder()
         .capacity(123)
         .description("description")
         .ruleGroup(RuleGroupProperty.builder()
                 .referenceSets(ReferenceSetsProperty.builder()
                         .ipSetReferences(Map.of(
                                 "ipSetReferencesKey", Map.of(
                                         "referenceArn", "referenceArn")))
                         .build())
                 .rulesSource(RulesSourceProperty.builder()
                         .rulesSourceList(RulesSourceListProperty.builder()
                                 .generatedRulesType("generatedRulesType")
                                 .targets(List.of("targets"))
                                 .targetTypes(List.of("targetTypes"))
                                 .build())
                         .rulesString("rulesString")
                         .statefulRules(List.of(StatefulRuleProperty.builder()
                                 .action("action")
                                 .header(HeaderProperty.builder()
                                         .destination("destination")
                                         .destinationPort("destinationPort")
                                         .direction("direction")
                                         .protocol("protocol")
                                         .source("source")
                                         .sourcePort("sourcePort")
                                         .build())
                                 .ruleOptions(List.of(RuleOptionProperty.builder()
                                         .keyword("keyword")
                                         .settings(List.of("settings"))
                                         .build()))
                                 .build()))
                         .statelessRulesAndCustomActions(StatelessRulesAndCustomActionsProperty.builder()
                                 .customActions(List.of(CustomActionProperty.builder()
                                         .actionDefinition(ActionDefinitionProperty.builder()
                                                 .publishMetricAction(PublishMetricActionProperty.builder()
                                                         .dimensions(List.of(DimensionProperty.builder()
                                                                 .value("value")
                                                                 .build()))
                                                         .build())
                                                 .build())
                                         .actionName("actionName")
                                         .build()))
                                 .statelessRules(List.of(StatelessRuleProperty.builder()
                                         .priority(123)
                                         .ruleDefinition(RuleDefinitionProperty.builder()
                                                 .actions(List.of("actions"))
                                                 .matchAttributes(MatchAttributesProperty.builder()
                                                         .destinationPorts(List.of(PortRangeProperty.builder()
                                                                 .fromPort(123)
                                                                 .toPort(123)
                                                                 .build()))
                                                         .destinations(List.of(AddressProperty.builder()
                                                                 .addressDefinition("addressDefinition")
                                                                 .build()))
                                                         .protocols(List.of(123))
                                                         .sourcePorts(List.of(PortRangeProperty.builder()
                                                                 .fromPort(123)
                                                                 .toPort(123)
                                                                 .build()))
                                                         .sources(List.of(AddressProperty.builder()
                                                                 .addressDefinition("addressDefinition")
                                                                 .build()))
                                                         .tcpFlags(List.of(TCPFlagFieldProperty.builder()
                                                                 .flags(List.of("flags"))
                                                                 .masks(List.of("masks"))
                                                                 .build()))
                                                         .build())
                                                 .build())
                                         .build()))
                                 .build())
                         .build())
                 .ruleVariables(RuleVariablesProperty.builder()
                         .ipSets(Map.of(
                                 "ipSetsKey", Map.of(
                                         "definition", List.of("definition"))))
                         .portSets(Map.of(
                                 "portSetsKey", PortSetProperty.builder()
                                         .definition(List.of("definition"))
                                         .build()))
                         .build())
                 .statefulRuleOptions(StatefulRuleOptionsProperty.builder()
                         .ruleOrder("ruleOrder")
                         .build())
                 .build())
         .ruleGroupName("ruleGroupName")
         .summaryConfiguration(SummaryConfigurationProperty.builder()
                 .ruleOptions(List.of("ruleOptions"))
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .type("type")
         .build())
 .strategy(mergeStrategy)
 .build();
 

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	CfnRuleGroupPropsMixin.ActionDefinitionProperty	A custom action to use in stateless rule actions settings.
static interface	CfnRuleGroupPropsMixin.AddressProperty	A single IP address specification.
static final class	CfnRuleGroupPropsMixin.Builder	A fluent builder for CfnRuleGroupPropsMixin.
static interface	CfnRuleGroupPropsMixin.CustomActionProperty	An optional, non-standard action to use for stateless packet handling.
static interface	CfnRuleGroupPropsMixin.DimensionProperty	The value to use in an Amazon CloudWatch custom metric dimension.
static interface	CfnRuleGroupPropsMixin.HeaderProperty	The 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection.
static interface	CfnRuleGroupPropsMixin.IPSetProperty	A list of IP addresses and address ranges, in CIDR notation.
static interface	CfnRuleGroupPropsMixin.IPSetReferenceProperty	Configures one or more IP set references for a Suricata-compatible rule group.
static interface	CfnRuleGroupPropsMixin.MatchAttributesProperty	Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.
static interface	CfnRuleGroupPropsMixin.PortRangeProperty	A single port range specification.
static interface	CfnRuleGroupPropsMixin.PortSetProperty	A set of port ranges for use in the rules in a rule group.
static interface	CfnRuleGroupPropsMixin.PublishMetricActionProperty	Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
static interface	CfnRuleGroupPropsMixin.ReferenceSetsProperty	Configures the reference sets for a stateful rule group.
static interface	CfnRuleGroupPropsMixin.RuleDefinitionProperty	The inspection criteria and action for a single stateless rule.
static interface	CfnRuleGroupPropsMixin.RuleGroupProperty	The object that defines the rules in a rule group.
static interface	CfnRuleGroupPropsMixin.RuleOptionProperty	Additional settings for a stateful rule.
static interface	CfnRuleGroupPropsMixin.RulesSourceListProperty	Stateful inspection criteria for a domain list rule group.
static interface	CfnRuleGroupPropsMixin.RulesSourceProperty	The stateless or stateful rules definitions for use in a single rule group.
static interface	CfnRuleGroupPropsMixin.RuleVariablesProperty	Settings that are available for use in the rules in the rule group where this is defined.
static interface	CfnRuleGroupPropsMixin.StatefulRuleOptionsProperty	Additional options governing how Network Firewall handles the rule group.
static interface	CfnRuleGroupPropsMixin.StatefulRuleProperty	A single Suricata rules specification, for use in a stateful rule group.
static interface	CfnRuleGroupPropsMixin.StatelessRuleProperty	A single stateless rule.
static interface	CfnRuleGroupPropsMixin.StatelessRulesAndCustomActionsProperty	Stateless inspection criteria.
static interface	CfnRuleGroupPropsMixin.SummaryConfigurationProperty	A complex type that specifies which Suricata rule metadata fields to use when displaying threat information.
static interface	CfnRuleGroupPropsMixin.TCPFlagFieldProperty	TCP flags and masks to inspect packets for.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.constructs.IMixin

software.constructs.IMixin.Jsii$Default, software.constructs.IMixin.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
protected static final List<String>	CFN_PROPERTY_KEYS

Constructor Summary

Constructors

Modifier	Constructor	Description
	CfnRuleGroupPropsMixin(CfnRuleGroupMixinProps props)	Create a mixin to apply properties to AWS::NetworkFirewall::RuleGroup.
	CfnRuleGroupPropsMixin(CfnRuleGroupMixinProps props, CfnPropertyMixinOptions options)	Create a mixin to apply properties to AWS::NetworkFirewall::RuleGroup.
protected	CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method	Description
void	applyTo(software.constructs.IConstruct construct)	Apply the mixin properties to the construct.
protected CfnRuleGroupMixinProps	getProps()
protected IMergeStrategy	getStrategy()
Boolean	supports(software.constructs.IConstruct construct)	Check if this mixin supports the given construct.

Methods inherited from class software.amazon.awscdk.Mixin

isMixin

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_PROPERTY_KEYS

@Stability(Stable)
protected static final List<String> CFN_PROPERTY_KEYS

Constructor Details

CfnRuleGroupPropsMixin

protected CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObjectRef objRef)

CfnRuleGroupPropsMixin

protected CfnRuleGroupPropsMixin(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnRuleGroupPropsMixin

@Stability(Stable)
public CfnRuleGroupPropsMixin(@NotNull
 CfnRuleGroupMixinProps props,
 @Nullable
 CfnPropertyMixinOptions options)

Create a mixin to apply properties to AWS::NetworkFirewall::RuleGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

options - Mixin options.

CfnRuleGroupPropsMixin

@Stability(Stable)
public CfnRuleGroupPropsMixin(@NotNull
 CfnRuleGroupMixinProps props)

Create a mixin to apply properties to AWS::NetworkFirewall::RuleGroup.

Parameters:

props - L1 properties to apply. This parameter is required.

Method Details

applyTo

@Stability(Stable)
public void applyTo(@NotNull
 software.constructs.IConstruct construct)

Apply the mixin properties to the construct.

Specified by:

applyTo in interface software.constructs.IMixin

Specified by:

applyTo in class Mixin

Parameters:

construct - This parameter is required.

supports

@Stability(Stable)
@NotNull
public Boolean supports(@NotNull
 software.constructs.IConstruct construct)

Check if this mixin supports the given construct.

Specified by:

supports in interface software.constructs.IMixin

Overrides:

supports in class Mixin

Parameters:

construct - This parameter is required.

getProps

@Stability(Stable)
@NotNull
protected CfnRuleGroupMixinProps getProps()

getStrategy

@Stability(Stable)
@NotNull
protected IMergeStrategy getStrategy()