Skip to content

FirewallPolicy

Source code in docs_src/capo_network_firewall/types/firewall_policy.py
class FirewallPolicy(TypedDict, closed=True):
    stateless_rule_group_references: NotRequired[
        "capo_network_firewall.types.stateless_rule_group_references.StatelessRuleGroupReferences"
    ]
    """<p>References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules. </p>"""
    stateless_default_actions: (
        "capo_network_firewall.types.stateless_actions.StatelessActions"
    )
    """<p>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 <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"""
    stateless_fragment_default_actions: (
        "capo_network_firewall.types.stateless_actions.StatelessActions"
    )
    """<p>The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP packets to be forwarded for stateful inspection, specify <code>aws:forward_to_sfe</code>. </p> <p>You must specify one of the standard actions: <code>aws:pass</code>, <code>aws:drop</code>, or <code>aws:forward_to_sfe</code>. In addition, you can specify custom actions that are compatible with your standard section choice.</p> <p>For example, you could specify <code>["aws:pass"]</code> or you could specify <code>["aws:pass", “customActionName”]</code>. For information about compatibility, see the custom action descriptions under <a>CustomAction</a>.</p>"""
    stateless_custom_actions: NotRequired[
        "capo_network_firewall.types.custom_actions.CustomActions"
    ]
    """<p>The custom action definitions that are available for use in the firewall policy's <code>StatelessDefaultActions</code> setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.</p>"""
    stateful_rule_group_references: NotRequired[
        "capo_network_firewall.types.stateful_rule_group_references.StatefulRuleGroupReferences"
    ]
    """<p>References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules. </p>"""
    stateful_default_actions: NotRequired[
        "capo_network_firewall.types.stateful_actions.StatefulActions"
    ]
    """<p>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.</p> <p>Valid values of the stateful default action:</p> <ul> <li> <p>aws:drop_strict</p> </li> <li> <p>aws:drop_established</p> </li> <li> <p>aws:alert_strict</p> </li> <li> <p>aws:alert_established</p> </li> <li> <p>aws:drop_established_app_layer</p> </li> <li> <p>aws:alert_established_app_layer</p> </li> <li> <p>aws:drop_established_app_layer_to_server</p> </li> <li> <p>aws:alert_established_app_layer_to_server</p> </li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html">Strict evaluation order</a> in the <i>Network Firewall Developer Guide</i>. </p>"""
    stateful_engine_options: NotRequired[
        "capo_network_firewall.types.stateful_engine_options.StatefulEngineOptions"
    ]
    """<p>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.</p>"""
    tls_inspection_configuration_arn: NotRequired[
        "capo_network_firewall.types.resource_arn.ResourceArn"
    ]
    """<p>The Amazon Resource Name (ARN) of the TLS inspection configuration.</p>"""
    policy_variables: NotRequired[
        "capo_network_firewall.types.policy_variables.PolicyVariables"
    ]
    """<p>Contains variables that you can use to override default Suricata settings in your firewall policy.</p>"""
    enable_tls_session_holding: NotRequired[
        "capo_network_firewall.types.enable_tls_session_holding.EnableTLSSessionHolding"
    ]
    """<p>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.</p>"""

enable_tls_session_holding instance-attribute

enable_tls_session_holding: NotRequired[EnableTLSSessionHolding]

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.

policy_variables instance-attribute

policy_variables: NotRequired[PolicyVariables]

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

stateful_default_actions instance-attribute

stateful_default_actions: NotRequired[StatefulActions]

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

  • aws:drop_established_app_layer

  • aws:alert_established_app_layer

  • aws:drop_established_app_layer_to_server

  • aws:alert_established_app_layer_to_server

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

stateful_engine_options instance-attribute

stateful_engine_options: NotRequired[StatefulEngineOptions]

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.

stateful_rule_group_references instance-attribute

stateful_rule_group_references: NotRequired[StatefulRuleGroupReferences]

References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.

stateless_custom_actions instance-attribute

stateless_custom_actions: NotRequired[CustomActions]

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.

stateless_default_actions instance-attribute

stateless_default_actions: StatelessActions

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 under CustomAction.

stateless_fragment_default_actions instance-attribute

stateless_fragment_default_actions: StatelessActions

The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols. If you want non-matching fragmented UDP 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 under CustomAction.

stateless_rule_group_references instance-attribute

stateless_rule_group_references: NotRequired[StatelessRuleGroupReferences]

References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.

tls_inspection_configuration_arn instance-attribute

tls_inspection_configuration_arn: NotRequired[ResourceArn]

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