Select your cookie preferences

We use essential cookies and similar tools that are necessary to provide our site and services. We use performance cookies to collect anonymous statistics, so we can understand how customers use our site and make improvements. Essential cookies cannot be deactivated, but you can choose “Customize” or “Decline” to decline performance cookies.

If you agree, AWS and approved third parties will also use cookies to provide useful site features, remember your preferences, and display relevant content, including relevant advertising. To accept or decline all non-essential cookies, choose “Accept” or “Decline.” To make more detailed choices, choose “Customize.”

Class: Aws::NetworkFirewall::Types::FirewallPolicy

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb

Overview

The firewall policy defines the behavior of a firewall using a collection of stateless and stateful rule groups and other settings. You can use one firewall policy for multiple firewalls.

This, along with FirewallPolicyResponse, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#policy_variables ⇒ Types::PolicyVariables

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

Returns:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateful_default_actions ⇒ Array<String>

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 Network Firewall Developer Guide.

Returns:

  • (Array<String>) 

2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateful_engine_options ⇒ Types::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.

Returns:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateful_rule_group_references ⇒ Array<Types::StatefulRuleGroupReference>

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

Returns:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateless_custom_actions ⇒ Array<Types::CustomAction>

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.

Returns:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateless_default_actions ⇒ Array<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 under CustomAction.

Returns:

  • (Array<String>) 

2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateless_fragment_default_actions ⇒ Array<String>

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.

Returns:

  • (Array<String>) 

2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#stateless_rule_group_references ⇒ Array<Types::StatelessRuleGroupReference>

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

Returns:


2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end

#tls_inspection_configuration_arn ⇒ String

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

Returns:

  • (String) 

2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
 
# File 'gems/aws-sdk-networkfirewall/lib/aws-sdk-networkfirewall/types.rb', line 2974

class FirewallPolicy < Struct.new(
  :stateless_rule_group_references,
  :stateless_default_actions,
  :stateless_fragment_default_actions,
  :stateless_custom_actions,
  :stateful_rule_group_references,
  :stateful_default_actions,
  :stateful_engine_options,
  :tls_inspection_configuration_arn,
  :policy_variables)
  SENSITIVE = []
  include Aws::Structure
end