aws-cdk-lib.aws_networkfirewall.CfnFirewallPolicy.FirewallPolicyProperty

FirewallPolicyProperty Struct

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

Source

Generated code

Type last changed

v2.223.0 · 10 Nov 2025

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
  enableTlsSessionHolding: false,
  policyVariables: {
    ruleVariables: {
      ruleVariablesKey: {
        definition: ['definition'],
      },
    },
  },
  statefulDefaultActions: ['statefulDefaultActions'],
  statefulEngineOptions: {
    flowTimeouts: {
      tcpIdleTimeoutSeconds: 123,
    },
    ruleOrder: 'ruleOrder',
    streamExceptionPolicy: 'streamExceptionPolicy',
  },
  statefulRuleGroupReferences: [{
    resourceArn: 'resourceArn',

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

Properties

enableTlsSessionHolding?optionalboolean | IResolvableenable_tls_session_holding?optionaltyping.Union[bool, IResolvable]enableTlsSessionHolding?optionalBooleanEnableTlsSessionHolding?optionalboolEnableTlsSessionHolding?optionalinterface{}#

When true, prevents TCP and TLS packets from reaching destination servers until TLS Inspection has evaluated Server Name Indication (SNI) rules.

Requires an associated TLS Inspection configuration.

policyVariables?optionalIResolvable | CfnFirewallPolicy.PolicyVariablesPropertypolicy_variables?optionaltyping.Union[IResolvable, PolicyVariablesProperty]policyVariables?optionalIResolvablePolicyVariables?optionalIResolvablePolicyVariables?optionalinterface{}#

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

statefulDefaultActions?optionalstring[]stateful_default_actions?optionaltyping.List[str]statefulDefaultActions?optionalList<String>StatefulDefaultActions?optionalstring[]StatefulDefaultActions?optional*[]*string#

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

notes

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?optionalIResolvable | CfnFirewallPolicy.StatefulEngineOptionsPropertystateful_engine_options?optionaltyping.Union[IResolvable, StatefulEngineOptionsProperty]statefulEngineOptions?optionalIResolvableStatefulEngineOptions?optionalIResolvableStatefulEngineOptions?optionalinterface{}#

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?optionalIResolvable | IResolvable | CfnFirewallPolicy.StatefulRuleGroupReferenceProperty[]stateful_rule_group_references?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StatefulRuleGroupReferenceProperty]]]statefulRuleGroupReferences?optionalIResolvableStatefulRuleGroupReferences?optionalIResolvableStatefulRuleGroupReferences?optionalinterface{}#

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

These define the inspection criteria in stateful rules.

statelessCustomActions?optionalIResolvable | IResolvable | CfnFirewallPolicy.CustomActionProperty[]stateless_custom_actions?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, CustomActionProperty]]]statelessCustomActions?optionalIResolvableStatelessCustomActions?optionalIResolvableStatelessCustomActions?optionalinterface{}#

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.

statelessDefaultActionsstring[]stateless_default_actionstyping.List[str]statelessDefaultActionsList<String>StatelessDefaultActionsstring[]StatelessDefaultActions*[]*stringrequired#

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

notes

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.

statelessFragmentDefaultActionsstring[]stateless_fragment_default_actionstyping.List[str]statelessFragmentDefaultActionsList<String>StatelessFragmentDefaultActionsstring[]StatelessFragmentDefaultActions*[]*stringrequired#

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

notes

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.

statelessRuleGroupReferences?optionalIResolvable | IResolvable | CfnFirewallPolicy.StatelessRuleGroupReferenceProperty[]stateless_rule_group_references?optionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, StatelessRuleGroupReferenceProperty]]]statelessRuleGroupReferences?optionalIResolvableStatelessRuleGroupReferences?optionalIResolvableStatelessRuleGroupReferences?optionalinterface{}#

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

These define the matching criteria in stateless rules.

tlsInspectionConfigurationArn?optionalstringtls_inspection_configuration_arn?optionalstrtlsInspectionConfigurationArn?optionalStringTlsInspectionConfigurationArn?optionalstringTlsInspectionConfigurationArn?optional*string#

The Amazon Resource Name (ARN) of the TLS inspection configuration.