interface StatefulRuleGroupReferenceProperty

Language	Type name
.NET	`Amazon.CDK.AWS.NetworkFirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsnetworkfirewall#CfnFirewallPolicy_StatefulRuleGroupReferenceProperty`
Java	`software.amazon.awscdk.services.networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty`
Python	`aws_cdk.aws_networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty`
TypeScript	`aws-cdk-lib` » `aws_networkfirewall` » `CfnFirewallPolicy` » `StatefulRuleGroupReferenceProperty`

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_networkfirewall as networkfirewall } from 'aws-cdk-lib';
const statefulRuleGroupReferenceProperty: networkfirewall.CfnFirewallPolicy.StatefulRuleGroupReferenceProperty = {
  resourceArn: 'resourceArn',

  // the properties below are optional
  deepThreatInspection: false,
  override: {
    action: 'action',
  },
  priority: 123,
};

Properties

Name	Type	Description
resourceArn	`string`	The Amazon Resource Name (ARN) of the stateful rule group.
deepThreatInspection?	`boolean \|` `IResolvable`	AWS Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability.
override?	`IResolvable` `\|` `StatefulRuleGroupOverrideProperty`	The action that allows the policy owner to override the behavior of the rule group within a policy.
priority?	`number`	An integer setting that indicates the order in which to run the stateful rule groups in a single firewall policy.

resourceArn

Type: string

The Amazon Resource Name (ARN) of the stateful rule group.

deepThreatInspection?

Type: boolean | IResolvable (optional)

AWS Network Firewall plans to augment the active threat defense managed rule group with an additional deep threat inspection capability.

When this capability is released, AWS will analyze service logs of network traffic processed by these rule groups to identify threat indicators across customers. AWS will use these threat indicators to improve the active threat defense managed rule groups and protect the security of AWS customers and services.

Customers can opt-out of deep threat inspection at any time through the AWS Network Firewall console or API. When customers opt out, AWS Network Firewall will not use the network traffic processed by those customers' active threat defense rule groups for rule group improvement.

override?

Type: IResolvable | StatefulRuleGroupOverrideProperty (optional)

The action that allows the policy owner to override the behavior of the rule group within a policy.

priority?

Type: number (optional)

An integer setting that indicates the order in which to run the stateful rule groups in a single firewall policy.

This setting only applies to firewall policies that specify the STRICT_ORDER rule order in the stateful engine options settings.

Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy.

You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on.