Package software.amazon.awscdk.services.networkfirewall

Class CfnFirewall

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.networkfirewall.CfnFirewall
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IFirewallRef, ITaggable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)", date="2025-12-01T16:02:24.970Z") @Stability(Stable) public class CfnFirewall extends CfnResource implements IInspectable, IFirewallRef, ITaggable
Use the firewall to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC .

The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.

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.*;
 CfnFirewall cfnFirewall = CfnFirewall.Builder.create(this, "MyCfnFirewall")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnFirewall

      protected CfnFirewall(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnFirewall

      protected CfnFirewall(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnFirewall

      @Stability(Stable) public CfnFirewall(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnFirewallProps props)
      Create a new AWS::NetworkFirewall::Firewall.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForFirewall

      @Stability(Stable) @NotNull public static String arnForFirewall(@NotNull IFirewallRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnFirewall

      @Stability(Stable) @NotNull public static Boolean isCfnFirewall(@NotNull Object x)
      Checks whether the given object is a CfnFirewall.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrEndpointIds

      @Stability(Stable) @NotNull public List<String> getAttrEndpointIds()
      The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall.

      The subnets are not listed in any particular order. For example: ["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"] .

    • getAttrFirewallArn

      @Stability(Stable) @NotNull public String getAttrFirewallArn()
      The Amazon Resource Name (ARN) of the firewall.

    • getAttrFirewallId

      @Stability(Stable) @NotNull public String getAttrFirewallId()
      The name of the firewallresource.

    • getAttrTransitGatewayAttachmentId

      @Stability(Stable) @NotNull public String getAttrTransitGatewayAttachmentId()
      The unique identifier of the transit gateway attachment associated with this firewall.

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

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFirewallRef

      @Stability(Stable) @NotNull public FirewallReference getFirewallRef()
      A reference to a Firewall resource.
      Specified by:
      getFirewallRef in interface IFirewallRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getFirewallName

      @Stability(Stable) @NotNull public String getFirewallName()
      The descriptive name of the firewall.

    • setFirewallName

      @Stability(Stable) public void setFirewallName(@NotNull String value)
      The descriptive name of the firewall.

    • getFirewallPolicyArn

      @Stability(Stable) @NotNull public String getFirewallPolicyArn()
      The Amazon Resource Name (ARN) of the firewall policy.

    • setFirewallPolicyArn

      @Stability(Stable) public void setFirewallPolicyArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the firewall policy.

    • getAvailabilityZoneChangeProtection

      @Stability(Stable) @Nullable public Object getAvailabilityZoneChangeProtection()
      A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

      Returns union: either Boolean or IResolvable

    • setAvailabilityZoneChangeProtection

      @Stability(Stable) public void setAvailabilityZoneChangeProtection(@Nullable Boolean value)
      A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

    • setAvailabilityZoneChangeProtection

      @Stability(Stable) public void setAvailabilityZoneChangeProtection(@Nullable IResolvable value)
      A setting indicating whether the firewall is protected against changes to its Availability Zone configuration.

    • getAvailabilityZoneMappings

      @Stability(Stable) @Nullable public Object getAvailabilityZoneMappings()
      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

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

    • setAvailabilityZoneMappings

      @Stability(Stable) public void setAvailabilityZoneMappings(@Nullable IResolvable value)
      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

    • setAvailabilityZoneMappings

      @Stability(Stable) public void setAvailabilityZoneMappings(@Nullable List<Object> value)
      The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall.

    • getDeleteProtection

      @Stability(Stable) @Nullable public Object getDeleteProtection()
      A flag indicating whether it is possible to delete the firewall.

      Returns union: either Boolean or IResolvable

    • setDeleteProtection

      @Stability(Stable) public void setDeleteProtection(@Nullable Boolean value)
      A flag indicating whether it is possible to delete the firewall.

    • setDeleteProtection

      @Stability(Stable) public void setDeleteProtection(@Nullable IResolvable value)
      A flag indicating whether it is possible to delete the firewall.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the firewall.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the firewall.

    • getEnabledAnalysisTypes

      @Stability(Stable) @Nullable public List<String> getEnabledAnalysisTypes()
      An optional setting indicating the specific traffic analysis types to enable on the firewall.

    • setEnabledAnalysisTypes

      @Stability(Stable) public void setEnabledAnalysisTypes(@Nullable List<String> value)
      An optional setting indicating the specific traffic analysis types to enable on the firewall.

    • getFirewallPolicyChangeProtection

      @Stability(Stable) @Nullable public Object getFirewallPolicyChangeProtection()
      A setting indicating whether the firewall is protected against a change to the firewall policy association.

      Returns union: either Boolean or IResolvable

    • setFirewallPolicyChangeProtection

      @Stability(Stable) public void setFirewallPolicyChangeProtection(@Nullable Boolean value)
      A setting indicating whether the firewall is protected against a change to the firewall policy association.

    • setFirewallPolicyChangeProtection

      @Stability(Stable) public void setFirewallPolicyChangeProtection(@Nullable IResolvable value)
      A setting indicating whether the firewall is protected against a change to the firewall policy association.

    • getSubnetChangeProtection

      @Stability(Stable) @Nullable public Object getSubnetChangeProtection()
      A setting indicating whether the firewall is protected against changes to the subnet associations.

      Returns union: either Boolean or IResolvable

    • setSubnetChangeProtection

      @Stability(Stable) public void setSubnetChangeProtection(@Nullable Boolean value)
      A setting indicating whether the firewall is protected against changes to the subnet associations.

    • setSubnetChangeProtection

      @Stability(Stable) public void setSubnetChangeProtection(@Nullable IResolvable value)
      A setting indicating whether the firewall is protected against changes to the subnet associations.

    • getSubnetMappings

      @Stability(Stable) @Nullable public Object getSubnetMappings()
      The primary public subnets that Network Firewall is using for the firewall.

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

    • setSubnetMappings

      @Stability(Stable) public void setSubnetMappings(@Nullable IResolvable value)
      The primary public subnets that Network Firewall is using for the firewall.

    • setSubnetMappings

      @Stability(Stable) public void setSubnetMappings(@Nullable List<Object> value)
      The primary public subnets that Network Firewall is using for the firewall.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      An array of key-value pairs to apply to this resource.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTransitGatewayId

      @Stability(Stable) @Nullable public String getTransitGatewayId()
      The unique identifier of the transit gateway associated with this firewall.

    • setTransitGatewayId

      @Stability(Stable) public void setTransitGatewayId(@Nullable String value)
      The unique identifier of the transit gateway associated with this firewall.

    • getVpcId

      @Stability(Stable) @Nullable public String getVpcId()
      The unique identifier of the VPC where the firewall is in use.

    • setVpcId

      @Stability(Stable) public void setVpcId(@Nullable String value)
      The unique identifier of the VPC where the firewall is in use.