Interface FirewallPolicy.Builder
- All Superinterfaces:
Buildable
,CopyableBuilder<FirewallPolicy.Builder,
,FirewallPolicy> SdkBuilder<FirewallPolicy.Builder,
,FirewallPolicy> SdkPojo
- Enclosing class:
FirewallPolicy
-
Method Summary
Modifier and TypeMethodDescriptiondefault FirewallPolicy.Builder
policyVariables
(Consumer<PolicyVariables.Builder> policyVariables) Contains variables that you can use to override default Suricata settings in your firewall policy.policyVariables
(PolicyVariables policyVariables) Contains variables that you can use to override default Suricata settings in your firewall policy.statefulDefaultActions
(String... statefulDefaultActions) The default actions to take on a packet that doesn't match any stateful rules.statefulDefaultActions
(Collection<String> statefulDefaultActions) The default actions to take on a packet that doesn't match any stateful rules.default FirewallPolicy.Builder
statefulEngineOptions
(Consumer<StatefulEngineOptions.Builder> statefulEngineOptions) Additional options governing how Network Firewall handles stateful rules.statefulEngineOptions
(StatefulEngineOptions statefulEngineOptions) Additional options governing how Network Firewall handles stateful rules.statefulRuleGroupReferences
(Collection<StatefulRuleGroupReference> statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy.statefulRuleGroupReferences
(Consumer<StatefulRuleGroupReference.Builder>... statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy.statefulRuleGroupReferences
(StatefulRuleGroupReference... statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy.statelessCustomActions
(Collection<CustomAction> statelessCustomActions) The custom action definitions that are available for use in the firewall policy'sStatelessDefaultActions
setting.statelessCustomActions
(Consumer<CustomAction.Builder>... statelessCustomActions) The custom action definitions that are available for use in the firewall policy'sStatelessDefaultActions
setting.statelessCustomActions
(CustomAction... statelessCustomActions) The custom action definitions that are available for use in the firewall policy'sStatelessDefaultActions
setting.statelessDefaultActions
(String... statelessDefaultActions) The actions to take on a packet if it doesn't match any of the stateless rules in the policy.statelessDefaultActions
(Collection<String> statelessDefaultActions) The actions to take on a packet if it doesn't match any of the stateless rules in the policy.statelessFragmentDefaultActions
(String... statelessFragmentDefaultActions) The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.statelessFragmentDefaultActions
(Collection<String> statelessFragmentDefaultActions) The actions to take on a fragmented UDP packet if it doesn't match any of the stateless rules in the policy.statelessRuleGroupReferences
(Collection<StatelessRuleGroupReference> statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy.statelessRuleGroupReferences
(Consumer<StatelessRuleGroupReference.Builder>... statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy.statelessRuleGroupReferences
(StatelessRuleGroupReference... statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy.tlsInspectionConfigurationArn
(String tlsInspectionConfigurationArn) The Amazon Resource Name (ARN) of the TLS inspection configuration.Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
statelessRuleGroupReferences
FirewallPolicy.Builder statelessRuleGroupReferences(Collection<StatelessRuleGroupReference> statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
- Parameters:
statelessRuleGroupReferences
- References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statelessRuleGroupReferences
FirewallPolicy.Builder statelessRuleGroupReferences(StatelessRuleGroupReference... statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
- Parameters:
statelessRuleGroupReferences
- References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statelessRuleGroupReferences
FirewallPolicy.Builder statelessRuleGroupReferences(Consumer<StatelessRuleGroupReference.Builder>... statelessRuleGroupReferences) References to the stateless rule groups that are used in the policy. These define the matching criteria in stateless rules.
This is a convenience method that creates an instance of theStatelessRuleGroupReference.Builder
avoiding the need to create one manually viaStatelessRuleGroupReference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatelessRuleGroupReferences(List<StatelessRuleGroupReference>)
.- Parameters:
statelessRuleGroupReferences
- a consumer that will call methods onStatelessRuleGroupReference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statelessDefaultActions
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
, oraws: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.- Parameters:
statelessDefaultActions
- 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, specifyaws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws: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:
- Returns a reference to this object so that method calls can be chained together.
-
statelessDefaultActions
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
, oraws: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.- Parameters:
statelessDefaultActions
- 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, specifyaws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws: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:
- Returns a reference to this object so that method calls can be chained together.
-
statelessFragmentDefaultActions
FirewallPolicy.Builder statelessFragmentDefaultActions(Collection<String> statelessFragmentDefaultActions) 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
, oraws: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.- Parameters:
statelessFragmentDefaultActions
- 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, specifyaws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws: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:
- Returns a reference to this object so that method calls can be chained together.
-
statelessFragmentDefaultActions
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
, oraws: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.- Parameters:
statelessFragmentDefaultActions
- 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, specifyaws:forward_to_sfe
.You must specify one of the standard actions:
aws:pass
,aws:drop
, oraws: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:
- Returns a reference to this object so that method calls can be chained together.
-
statelessCustomActions
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.- Parameters:
statelessCustomActions
- The custom action definitions that are available for use in the firewall policy'sStatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statelessCustomActions
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.- Parameters:
statelessCustomActions
- The custom action definitions that are available for use in the firewall policy'sStatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statelessCustomActions
FirewallPolicy.Builder statelessCustomActions(Consumer<CustomAction.Builder>... statelessCustomActions) The custom action definitions that are available for use in the firewall policy's
This is a convenience method that creates an instance of theStatelessDefaultActions
setting. You name each custom action that you define, and then you can use it by name in your default actions specifications.CustomAction.Builder
avoiding the need to create one manually viaCustomAction.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatelessCustomActions(List<CustomAction>)
.- Parameters:
statelessCustomActions
- a consumer that will call methods onCustomAction.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statefulRuleGroupReferences
FirewallPolicy.Builder statefulRuleGroupReferences(Collection<StatefulRuleGroupReference> statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
- Parameters:
statefulRuleGroupReferences
- References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statefulRuleGroupReferences
FirewallPolicy.Builder statefulRuleGroupReferences(StatefulRuleGroupReference... statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
- Parameters:
statefulRuleGroupReferences
- References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
statefulRuleGroupReferences
FirewallPolicy.Builder statefulRuleGroupReferences(Consumer<StatefulRuleGroupReference.Builder>... statefulRuleGroupReferences) References to the stateful rule groups that are used in the policy. These define the inspection criteria in stateful rules.
This is a convenience method that creates an instance of theStatefulRuleGroupReference.Builder
avoiding the need to create one manually viaStatefulRuleGroupReference.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatefulRuleGroupReferences(List<StatefulRuleGroupReference>)
.- Parameters:
statefulRuleGroupReferences
- a consumer that will call methods onStatefulRuleGroupReference.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
statefulDefaultActions
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.
- Parameters:
statefulDefaultActions
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
statefulDefaultActions
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.
- Parameters:
statefulDefaultActions
- 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:
- Returns a reference to this object so that method calls can be chained together.
-
-
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.
- Parameters:
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:
- Returns a reference to this object so that method calls can be chained together.
-
statefulEngineOptions
default FirewallPolicy.Builder statefulEngineOptions(Consumer<StatefulEngineOptions.Builder> 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.
This is a convenience method that creates an instance of theStatefulEngineOptions.Builder
avoiding the need to create one manually viaStatefulEngineOptions.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed tostatefulEngineOptions(StatefulEngineOptions)
.- Parameters:
statefulEngineOptions
- a consumer that will call methods onStatefulEngineOptions.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tlsInspectionConfigurationArn
The Amazon Resource Name (ARN) of the TLS inspection configuration.
- Parameters:
tlsInspectionConfigurationArn
- The Amazon Resource Name (ARN) of the TLS inspection configuration.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyVariables
Contains variables that you can use to override default Suricata settings in your firewall policy.
- Parameters:
policyVariables
- Contains variables that you can use to override default Suricata settings in your firewall policy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
policyVariables
Contains variables that you can use to override default Suricata settings in your firewall policy.
This is a convenience method that creates an instance of thePolicyVariables.Builder
avoiding the need to create one manually viaPolicyVariables.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed topolicyVariables(PolicyVariables)
.- Parameters:
policyVariables
- a consumer that will call methods onPolicyVariables.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-