Package software.amazon.awscdk.services.networkfirewall

Interface CfnFirewallPolicy.FirewallPolicyProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFirewallPolicy.FirewallPolicyProperty.Jsii$Proxy

Enclosing class:

CfnFirewallPolicy

@Stability(Stable)
public static interface CfnFirewallPolicy.FirewallPolicyProperty
extends software.amazon.jsii.JsiiSerializable

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 software.amazon.awscdk.services.networkfirewall.*;
 FirewallPolicyProperty firewallPolicyProperty = FirewallPolicyProperty.builder()
         .statelessDefaultActions(List.of("statelessDefaultActions"))
         .statelessFragmentDefaultActions(List.of("statelessFragmentDefaultActions"))
         // the properties below are optional
         .policyVariables(PolicyVariablesProperty.builder()
                 .ruleVariables(Map.of(
                         "ruleVariablesKey", Map.of(
                                 "definition", List.of("definition"))))
                 .build())
         .statefulDefaultActions(List.of("statefulDefaultActions"))
         .statefulEngineOptions(StatefulEngineOptionsProperty.builder()
                 .ruleOrder("ruleOrder")
                 .streamExceptionPolicy("streamExceptionPolicy")
                 .build())
         .statefulRuleGroupReferences(List.of(StatefulRuleGroupReferenceProperty.builder()
                 .resourceArn("resourceArn")
                 // the properties below are optional
                 .override(StatefulRuleGroupOverrideProperty.builder()
                         .action("action")
                         .build())
                 .priority(123)
                 .build()))
         .statelessCustomActions(List.of(CustomActionProperty.builder()
                 .actionDefinition(ActionDefinitionProperty.builder()
                         .publishMetricAction(PublishMetricActionProperty.builder()
                                 .dimensions(List.of(DimensionProperty.builder()
                                         .value("value")
                                         .build()))
                                 .build())
                         .build())
                 .actionName("actionName")
                 .build()))
         .statelessRuleGroupReferences(List.of(StatelessRuleGroupReferenceProperty.builder()
                 .priority(123)
                 .resourceArn("resourceArn")
                 .build()))
         .tlsInspectionConfigurationArn("tlsInspectionConfigurationArn")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnFirewallPolicy.FirewallPolicyProperty.Builder	A builder for CfnFirewallPolicy.FirewallPolicyProperty
static final class	CfnFirewallPolicy.FirewallPolicyProperty.Jsii$Proxy	An implementation for CfnFirewallPolicy.FirewallPolicyProperty

Method Summary

Modifier and Type	Method	Description
static CfnFirewallPolicy.FirewallPolicyProperty.Builder	builder()
default Object	getPolicyVariables()	Contains variables that you can use to override default Suricata settings in your firewall policy.
default List<String>	getStatefulDefaultActions()	The default actions to take on a packet that doesn't match any stateful rules.
default Object	getStatefulEngineOptions()	Additional options governing how Network Firewall handles stateful rules.
default Object	getStatefulRuleGroupReferences()	References to the stateful rule groups that are used in the policy.
default Object	getStatelessCustomActions()	The custom action definitions that are available for use in the firewall policy's StatelessDefaultActions setting.
List<String>	getStatelessDefaultActions()	The actions to take on a packet if it doesn't match any of the stateless rules in the policy.
List<String>	getStatelessFragmentDefaultActions()	The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy.
default Object	getStatelessRuleGroupReferences()	References to the stateless rule groups that are used in the policy.
default String	getTlsInspectionConfigurationArn()	The Amazon Resource Name (ARN) of the TLS inspection configuration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getStatelessDefaultActions

@Stability(Stable)
@NotNull
List<String> getStatelessDefaultActions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions

getStatelessFragmentDefaultActions

@Stability(Stable)
@NotNull
List<String> getStatelessFragmentDefaultActions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions

getPolicyVariables

@Stability(Stable)
@Nullable
default Object getPolicyVariables()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables

getStatefulDefaultActions

@Stability(Stable)
@Nullable
default List<String> getStatefulDefaultActions()

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 .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions

getStatefulEngineOptions

@Stability(Stable)
@Nullable
default Object getStatefulEngineOptions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions

getStatefulRuleGroupReferences

@Stability(Stable)
@Nullable
default Object getStatefulRuleGroupReferences()

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

These define the inspection criteria in stateful rules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences

getStatelessCustomActions

@Stability(Stable)
@Nullable
default Object getStatelessCustomActions()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions

getStatelessRuleGroupReferences

@Stability(Stable)
@Nullable
default Object getStatelessRuleGroupReferences()

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

These define the matching criteria in stateless rules.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences

getTlsInspectionConfigurationArn

@Stability(Stable)
@Nullable
default String getTlsInspectionConfigurationArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn

builder

@Stability(Stable)
static CfnFirewallPolicy.FirewallPolicyProperty.Builder builder()

Returns:

a CfnFirewallPolicy.FirewallPolicyProperty.Builder of CfnFirewallPolicy.FirewallPolicyProperty