Firewall class
Provides an AWS Network Firewall Firewall Resource
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = new aws.networkfirewall.Firewall("example", {
subnetMappings: [{
subnetId: exampleAwsSubnet.id,
}],
name: "example",
firewallPolicyArn: exampleAwsNetworkfirewallFirewallPolicy.arn,
vpcId: exampleAwsVpc.id,
enabledAnalysisTypes: [
"TLS_SNI",
"HTTP_HOST",
],
tags: {
Tag1: "Value1",
Tag2: "Value2",
},
}, {
customTimeouts: {
create: "40m",
update: "50m",
"delete": "1h",
},
});
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.Firewall("example",
subnet_mappings=[{
"subnet_id": example_aws_subnet["id"],
}],
name="example",
firewall_policy_arn=example_aws_networkfirewall_firewall_policy["arn"],
vpc_id=example_aws_vpc["id"],
enabled_analysis_types=[
"TLS_SNI",
"HTTP_HOST",
],
tags={
"Tag1": "Value1",
"Tag2": "Value2",
},
opts = pulumi.ResourceOptions(custom_timeouts=pulumi.CustomTimeouts(create="40m", update="50m", delete="1h")))
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = new Aws.NetworkFirewall.Firewall("example", new()
{
SubnetMappings = new[]
{
new Aws.NetworkFirewall.Inputs.FirewallSubnetMappingArgs
{
SubnetId = exampleAwsSubnet.Id,
},
},
Name = "example",
FirewallPolicyArn = exampleAwsNetworkfirewallFirewallPolicy.Arn,
VpcId = exampleAwsVpc.Id,
EnabledAnalysisTypes = new[]
{
"TLS_SNI",
"HTTP_HOST",
},
Tags =
{
{ "Tag1", "Value1" },
{ "Tag2", "Value2" },
},
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkfirewall"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := networkfirewall.NewFirewall(ctx, "example", &networkfirewall.FirewallArgs{
SubnetMappings: networkfirewall.FirewallSubnetMappingArray{
&networkfirewall.FirewallSubnetMappingArgs{
SubnetId: pulumi.Any(exampleAwsSubnet.Id),
},
},
Name: pulumi.String("example"),
FirewallPolicyArn: pulumi.Any(exampleAwsNetworkfirewallFirewallPolicy.Arn),
VpcId: pulumi.Any(exampleAwsVpc.Id),
EnabledAnalysisTypes: pulumi.StringArray{
pulumi.String("TLS_SNI"),
pulumi.String("HTTP_HOST"),
},
Tags: pulumi.StringMap{
"Tag1": pulumi.String("Value1"),
"Tag2": pulumi.String("Value2"),
},
}, pulumi.Timeouts(&pulumi.CustomTimeouts{Create: "40m", Update: "50m", Delete: "1h"}))
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
resource "aws_networkfirewall_firewall" "example" {
timeouts {
create = "40m"
update = "50m"
delete = "1h"
}
subnet_mappings {
subnet_id = exampleAwsSubnet.id
}
name = "example"
firewall_policy_arn = exampleAwsNetworkfirewallFirewallPolicy.arn
vpc_id = exampleAwsVpc.id
enabled_analysis_types = ["TLS_SNI", "HTTP_HOST"]
tags = {
"Tag1" = "Value1"
"Tag2" = "Value2"
}
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.networkfirewall.Firewall;
import com.pulumi.aws.networkfirewall.FirewallArgs;
import com.pulumi.aws.networkfirewall.inputs.FirewallSubnetMappingArgs;
import com.pulumi.resources.CustomResourceOptions;
import com.pulumi.resources.CustomTimeouts;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var example = new Firewall("example", FirewallArgs.builder()
.subnetMappings(FirewallSubnetMappingArgs.builder()
.subnetId(exampleAwsSubnet.id())
.build())
.name("example")
.firewallPolicyArn(exampleAwsNetworkfirewallFirewallPolicy.arn())
.vpcId(exampleAwsVpc.id())
.enabledAnalysisTypes(
"TLS_SNI",
"HTTP_HOST")
.tags(Map.ofEntries(
Map.entry("Tag1", "Value1"),
Map.entry("Tag2", "Value2")
))
.build(), CustomResourceOptions.builder()
.customTimeouts(CustomTimeouts.builder()
.create(CustomTimeouts.parseTimeoutString("40m"))
.update(CustomTimeouts.parseTimeoutString("50m"))
.delete(CustomTimeouts.parseTimeoutString("1h"))
.build())
.build());
}
}
resources:
example:
type: aws:networkfirewall:Firewall
properties:
subnetMappings:
- subnetId: ${exampleAwsSubnet.id}
name: example
firewallPolicyArn: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
vpcId: ${exampleAwsVpc.id}
enabledAnalysisTypes:
- TLS_SNI
- HTTP_HOST
tags:
Tag1: Value1
Tag2: Value2
options:
customTimeouts:
create: 40m
update: 50m
delete: 1h
Transit Gateway Attached Firewall
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const example = aws.getAvailabilityZones({
state: "available",
});
const exampleFirewall = new aws.networkfirewall.Firewall("example", {
availabilityZoneMappings: [
{
availabilityZoneId: example.then(example => example.zoneIds?.[0]),
},
{
availabilityZoneId: example.then(example => example.zoneIds?.[1]),
},
],
name: "example",
firewallPolicyArn: exampleAwsNetworkfirewallFirewallPolicy.arn,
transitGatewayId: exampleAwsEc2TransitGateway.id,
});
import pulumi
import pulumi_aws as aws
example = aws.get_availability_zones(state="available")
example_firewall = aws.networkfirewall.Firewall("example",
availability_zone_mappings=[
{
"availability_zone_id": example.zone_ids[0],
},
{
"availability_zone_id": example.zone_ids[1],
},
],
name="example",
firewall_policy_arn=example_aws_networkfirewall_firewall_policy["arn"],
transit_gateway_id=example_aws_ec2_transit_gateway["id"])
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
var example = Aws.GetAvailabilityZones.Invoke(new()
{
State = "available",
});
var exampleFirewall = new Aws.NetworkFirewall.Firewall("example", new()
{
AvailabilityZoneMappings = new[]
{
new Aws.NetworkFirewall.Inputs.FirewallAvailabilityZoneMappingArgs
{
AvailabilityZoneId = example.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.ZoneIds[0]),
},
new Aws.NetworkFirewall.Inputs.FirewallAvailabilityZoneMappingArgs
{
AvailabilityZoneId = example.Apply(getAvailabilityZonesResult => getAvailabilityZonesResult.ZoneIds[1]),
},
},
Name = "example",
FirewallPolicyArn = exampleAwsNetworkfirewallFirewallPolicy.Arn,
TransitGatewayId = exampleAwsEc2TransitGateway.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws"
"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/networkfirewall"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
example, err := aws.GetAvailabilityZones(ctx, &aws.GetAvailabilityZonesArgs{
State: pulumi.StringRef("available"),
}, nil)
if err != nil {
return err
}
_, err = networkfirewall.NewFirewall(ctx, "example", &networkfirewall.FirewallArgs{
AvailabilityZoneMappings: networkfirewall.FirewallAvailabilityZoneMappingArray{
&networkfirewall.FirewallAvailabilityZoneMappingArgs{
AvailabilityZoneId: pulumi.String(example.ZoneIds[0]),
},
&networkfirewall.FirewallAvailabilityZoneMappingArgs{
AvailabilityZoneId: pulumi.String(example.ZoneIds[1]),
},
},
Name: pulumi.String("example"),
FirewallPolicyArn: pulumi.Any(exampleAwsNetworkfirewallFirewallPolicy.Arn),
TransitGatewayId: pulumi.Any(exampleAwsEc2TransitGateway.Id),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
aws = {
source = "pulumi/aws"
}
}
}
data "aws_getavailabilityzones" "example" {
state = "available"
}
resource "aws_networkfirewall_firewall" "example" {
availability_zone_mappings {
availability_zone_id = data.aws_getavailabilityzones.example.zone_ids[0]
}
availability_zone_mappings {
availability_zone_id = data.aws_getavailabilityzones.example.zone_ids[1]
}
name = "example"
firewall_policy_arn = exampleAwsNetworkfirewallFirewallPolicy.arn
transit_gateway_id = exampleAwsEc2TransitGateway.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.AwsFunctions;
import com.pulumi.aws.inputs.GetAvailabilityZonesArgs;
import com.pulumi.aws.networkfirewall.Firewall;
import com.pulumi.aws.networkfirewall.FirewallArgs;
import com.pulumi.aws.networkfirewall.inputs.FirewallAvailabilityZoneMappingArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var example = AwsFunctions.getAvailabilityZones(GetAvailabilityZonesArgs.builder()
.state("available")
.build());
var exampleFirewall = new Firewall("exampleFirewall", FirewallArgs.builder()
.availabilityZoneMappings(
FirewallAvailabilityZoneMappingArgs.builder()
.availabilityZoneId(example.zoneIds()[0])
.build(),
FirewallAvailabilityZoneMappingArgs.builder()
.availabilityZoneId(example.zoneIds()[1])
.build())
.name("example")
.firewallPolicyArn(exampleAwsNetworkfirewallFirewallPolicy.arn())
.transitGatewayId(exampleAwsEc2TransitGateway.id())
.build());
}
}
resources:
exampleFirewall:
type: aws:networkfirewall:Firewall
name: example
properties:
availabilityZoneMappings:
- availabilityZoneId: ${example.zoneIds[0]}
- availabilityZoneId: ${example.zoneIds[1]}
name: example
firewallPolicyArn: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
transitGatewayId: ${exampleAwsEc2TransitGateway.id}
variables:
example:
fn::invoke:
function: aws:getAvailabilityZones
arguments:
state: available
Transit Gateway Attached Firewall (Cross Account)
A full example of how to create a Transit Gateway in one AWS account, share it with a second AWS account, and create Network Firewall in the second account to the Transit Gateway via the aws.networkfirewall.Firewall and aws.networkfirewall.FirewallTransitGatewayAttachmentAccepter resources can be found in the ./examples/network-firewall-cross-account-transit-gateway directory within the Github Repository
Import
Using pulumi import, import Network Firewall Firewalls using their arn. For example:
$ pulumi import aws:networkfirewall/firewall:Firewall example arn:aws:network-firewall:us-west-1:123456789012:firewall/example
Constructors
- Firewall(String name, {FirewallArgs? args, CustomResourceOptions? options})
-
Creates a new Firewall.
nameThe Pulumi resource name.argsArguments used to configure this Firewall. The set of arguments for Firewall.optionsResource options controlling this resource's behavior. - Firewall.reference(String urn)
- Creates a typed reference to an existing Firewall resource.
Properties
-
arn
↔ Output<
String> -
ARN that identifies the firewall.
latefinal
-
availabilityZoneChangeProtection
↔ Output<
bool?> -
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.latefinal -
availabilityZoneMappings
↔ Output<
List< FirewallAvailabilityZoneMapping> > -
Required when creating a transit gateway-attached firewall. Set of configuration blocks describing the avaiability availability where you want to create firewall endpoints for a transit gateway-attached firewall.
latefinal
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
deleteProtection
↔ Output<
bool?> -
A flag indicating whether the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. Defaults to
false.latefinal -
description
↔ Output<
String?> -
A friendly description of the firewall.
latefinal
-
enabledAnalysisTypes
↔ Output<
List< String> ?> -
Set of types for which to collect analysis metrics. See Reporting on network traffic in Network Firewall for details on how to use the data. Valid values:
TLS_SNI,HTTP_HOST. Defaults to[].latefinal -
encryptionConfiguration
↔ Output<
FirewallEncryptionConfiguration?> -
KMS encryption configuration settings. See Encryption Configuration below for details.
latefinal
-
firewallPolicyArn
↔ Output<
String> -
ARN of the VPC Firewall policy.
latefinal
-
firewallPolicyChangeProtection
↔ Output<
bool?> -
A flag 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. Defaults to
false.latefinal -
firewallStatuses
↔ Output<
List< FirewallFirewallStatus> > -
Nested list of information about the current status of the firewall.
latefinal
- hashCode → int
-
The hash code for this object.
no setterinherited
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
A friendly name of the firewall.
latefinal
-
region
↔ Output<
String> -
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
-
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
subnetChangeProtection
↔ Output<
bool?> -
A flag 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. Defaults to
false.latefinal -
subnetMappings
↔ Output<
List< FirewallSubnetMapping> ?> -
Required when creating a VPC attached firewall. Set of configuration blocks describing the public subnets. Each subnet must belong to a different Availability Zone in the VPC. AWS Network Firewall creates a firewall endpoint in each subnet. See Subnet Mapping below for details.
latefinal
-
Map of resource tags to associate with the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.latefinal -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.latefinal -
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
transitGatewayId
↔ Output<
String?> -
. Required when creating a transit gateway-attached firewall. The unique identifier of the transit gateway to attach to this firewall. You can provide either a transit gateway from your account or one that has been shared with you through AWS Resource Access Manager
latefinal
-
transitGatewayOwnerAccountId
↔ Output<
String> -
The AWS account ID that owns the transit gateway.
latefinal
-
updateToken
↔ Output<
String> -
A string token used when updating a firewall.
latefinal
-
urn
↔ Output<
String> -
latefinalinherited
-
vpcId
↔ Output<
String?> -
Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
latefinal
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited