Package software.amazon.awscdk.services.networkfirewall

Interface CfnFirewallProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnFirewallProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:56.134Z")
@Stability(Stable)
public interface CfnFirewallProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnFirewall.

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.*;
 CfnFirewallProps cfnFirewallProps = CfnFirewallProps.builder()
         .firewallName("firewallName")
         .firewallPolicyArn("firewallPolicyArn")
         // the properties below are optional
         .availabilityZoneChangeProtection(false)
         .availabilityZoneMappings(List.of(AvailabilityZoneMappingProperty.builder()
                 .availabilityZone("availabilityZone")
                 .build()))
         .deleteProtection(false)
         .description("description")
         .enabledAnalysisTypes(List.of("enabledAnalysisTypes"))
         .firewallPolicyChangeProtection(false)
         .subnetChangeProtection(false)
         .subnetMappings(List.of(SubnetMappingProperty.builder()
                 .subnetId("subnetId")
                 // the properties below are optional
                 .ipAddressType("ipAddressType")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .transitGatewayId("transitGatewayId")
         .vpcId("vpcId")
         .build();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnFirewallProps.Builder	builder()
default Object	getAvailabilityZoneChangeProtection()	A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.
default Object	getAvailabilityZoneMappings()	The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.
default Object	getDeleteProtection()	A flag indicating whether it is possible to delete the firewall.
default String	getDescription()	A description of the firewall.
default List<String>	getEnabledAnalysisTypes()	An optional setting indicating the specific traffic analysis types to enable on the firewall.
String	getFirewallName()	The descriptive name of the firewall.
String	getFirewallPolicyArn()	The Amazon Resource Name (ARN) of the firewall policy.
default Object	getFirewallPolicyChangeProtection()	A setting indicating whether the firewall is protected against a change to the firewall policy association.
default Object	getSubnetChangeProtection()	A setting indicating whether the firewall is protected against changes to the subnet associations.
default Object	getSubnetMappings()	The primary public subnets that Network Firewall is using for the firewall.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default String	getTransitGatewayId()	The unique identifier of the transit gateway associated with this firewall.
default String	getVpcId()	The unique identifier of the VPC where the firewall is in use.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFirewallName

@Stability(Stable)
@NotNull
String getFirewallName()

The descriptive name of the firewall.

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

See Also:

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

getFirewallPolicyArn

@Stability(Stable)
@NotNull
String getFirewallPolicyArn()

The Amazon Resource Name (ARN) of the firewall policy.

The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.

See Also:

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

getAvailabilityZoneChangeProtection

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

A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

When set to TRUE , you must first disable this protection before adding or removing Availability Zones.

Returns union: either Boolean or IResolvable

See Also:

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

getAvailabilityZoneMappings

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

The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

Each mapping specifies an Availability Zone where the firewall processes traffic.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFirewall.AvailabilityZoneMappingProperty>

See Also:

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

getDeleteProtection

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

A flag indicating whether it is possible to delete the firewall.

A setting of TRUE indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE .

Returns union: either Boolean or IResolvable

See Also:

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

getDescription

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

A description of the firewall.

See Also:

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

getEnabledAnalysisTypes

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

An optional setting indicating the specific traffic analysis types to enable on the firewall.

See Also:

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

getFirewallPolicyChangeProtection

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

A setting indicating whether the firewall is protected against a change to the firewall policy association.

Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Returns union: either Boolean or IResolvable

See Also:

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

getSubnetChangeProtection

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

A setting indicating whether the firewall is protected against changes to the subnet associations.

Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE .

Returns union: either Boolean or IResolvable

See Also:

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

getSubnetMappings

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

The primary public subnets that Network Firewall is using for the firewall.

Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.

These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.

In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.

Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnFirewall.SubnetMappingProperty>

See Also:

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

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-firewall.html#cfn-networkfirewall-firewall-tags

getTransitGatewayId

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

The unique identifier of the transit gateway associated with this firewall.

This field is only present for transit gateway-attached firewalls.

See Also:

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

getVpcId

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

The unique identifier of the VPC where the firewall is in use.

You can't change the VPC of a firewall after you create the firewall.

See Also:

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

builder

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

Returns:

a CfnFirewallProps.Builder of CfnFirewallProps