Package software.amazon.awscdk.services.networkfirewall

Interface CfnFirewallPolicyProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFirewallPolicyProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
           date="2024-04-18T17:54:20.136Z")
@Stability(Stable)
public interface CfnFirewallPolicyProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFirewallPolicy.

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.*;
 CfnFirewallPolicyProps cfnFirewallPolicyProps = CfnFirewallPolicyProps.builder()
         .firewallPolicy(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())
         .firewallPolicyName("firewallPolicyName")
         // the properties below are optional
         .description("description")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFirewallPolicyProps.Builder	builder()
default String	getDescription()	A description of the firewall policy.
Object	getFirewallPolicy()	The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
String	getFirewallPolicyName()	The descriptive name of the firewall policy.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFirewallPolicy

@Stability(Stable)
@NotNull
Object getFirewallPolicy()

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

See Also:

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

getFirewallPolicyName

@Stability(Stable)
@NotNull
String getFirewallPolicyName()

The descriptive name of the firewall policy.

You can't change the name of a firewall policy after you create it.

See Also:

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

getDescription

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

A description of the firewall policy.

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

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

builder

@Stability(Stable)
static CfnFirewallPolicyProps.Builder builder()

Returns:

a CfnFirewallPolicyProps.Builder of CfnFirewallPolicyProps