aws-cdk-lib.aws_networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty

interface FirewallPolicyProperty

LanguageType name
.NETAmazon.CDK.AWS.NetworkFirewall.CfnFirewallPolicy.FirewallPolicyProperty
Gogithub.com/aws/aws-cdk-go/awscdk/v2/awsnetworkfirewall#CfnFirewallPolicy_FirewallPolicyProperty
Javasoftware.amazon.awscdk.services.networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty
Pythonaws_cdk.aws_networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty
TypeScript aws-cdk-lib » aws_networkfirewall » CfnFirewallPolicy » FirewallPolicyProperty

The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.

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 firewallPolicyProperty: networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty = {
  statelessDefaultActions: ['statelessDefaultActions'],
  statelessFragmentDefaultActions: ['statelessFragmentDefaultActions'],

  // the properties below are optional
  policyVariables: {
    ruleVariables: {
      ruleVariablesKey: {
        definition: ['definition'],
      },
    },
  },
  statefulDefaultActions: ['statefulDefaultActions'],
  statefulEngineOptions: {
    ruleOrder: 'ruleOrder',
    streamExceptionPolicy: 'streamExceptionPolicy',
  },
  statefulRuleGroupReferences: [{
    resourceArn: 'resourceArn',

    // the properties below are optional
    override: {
      action: 'action',
    },
    priority: 123,
  }],
  statelessCustomActions: [{
    actionDefinition: {
      publishMetricAction: {
        dimensions: [{
          value: 'value',
        }],
      },
    },
    actionName: 'actionName',
  }],
  statelessRuleGroupReferences: [{
    priority: 123,
    resourceArn: 'resourceArn',
  }],
};

Properties

NameTypeDescription
statelessDefaultActionsstring[]The actions to take on a packet if it doesn't match any of the stateless rules in the policy.
statelessFragmentDefaultActionsstring[]The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy.
policyVariables?IResolvable | PolicyVariablesPropertyContains variables that you can use to override default Suricata settings in your firewall policy.
statefulDefaultActions?string[]The default actions to take on a packet that doesn't match any stateful rules.
statefulEngineOptions?IResolvable | StatefulEngineOptionsPropertyAdditional options governing how Network Firewall handles stateful rules.
statefulRuleGroupReferences?IResolvable | IResolvable | StatefulRuleGroupReferenceProperty[]References to the stateful rule groups that are used in the policy.
statelessCustomActions?IResolvable | IResolvable | CustomActionProperty[]The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting.
statelessRuleGroupReferences?IResolvable | IResolvable | StatelessRuleGroupReferenceProperty[]References to the stateless rule groups that are used in the policy.

statelessDefaultActions

Type: string[]

The actions to take on a packet if it doesn't match any of the stateless rules in the policy.

If you want non-matching packets to be forwarded for stateful inspection, specify aws:forward_to_sfe .

You must specify one of the standard actions: aws:pass , aws:drop , or aws:forward_to_sfe . In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”] . For information about compatibility, see the custom action descriptions.


statelessFragmentDefaultActions

Type: string[]

The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy.

If you want non-matching fragmented packets to be forwarded for stateful inspection, specify aws:forward_to_sfe .

You must specify one of the standard actions: aws:pass , aws:drop , or aws:forward_to_sfe . In addition, you can specify custom actions that are compatible with your standard section choice.

For example, you could specify ["aws:pass"] or you could specify ["aws:pass", “customActionName”] . For information about compatibility, see the custom action descriptions.


policyVariables?

Type: IResolvable | PolicyVariablesProperty (optional)

Contains variables that you can use to override default Suricata settings in your firewall policy.


statefulDefaultActions?

Type: string[] (optional)

The default actions to take on a packet that doesn't match any stateful rules.

The stateful default action is optional, and is only valid when using the strict rule order.

Valid values of the stateful default action:

  • aws:drop_strict
  • aws:drop_established
  • aws:alert_strict
  • aws:alert_established

For more information, see Strict evaluation order in the AWS Network Firewall Developer Guide .


statefulEngineOptions?

Type: IResolvable | StatefulEngineOptionsProperty (optional)

Additional options governing how Network Firewall handles stateful rules.

The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.


statefulRuleGroupReferences?

Type: IResolvable | IResolvable | StatefulRuleGroupReferenceProperty[] (optional)

References to the stateful rule groups that are used in the policy.

These define the inspection criteria in stateful rules.


statelessCustomActions?

Type: IResolvable | IResolvable | CustomActionProperty[] (optional)

The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting.

You name each custom action that you define, and then you can use it by name in your default actions specifications.


statelessRuleGroupReferences?

Type: IResolvable | IResolvable | StatelessRuleGroupReferenceProperty[] (optional)

References to the stateless rule groups that are used in the policy.

These define the matching criteria in stateless rules.