aws.networkfirewall.Firewall
Explore with Pulumi AI
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", {
name: "example",
firewallPolicyArn: exampleAwsNetworkfirewallFirewallPolicy.arn,
vpcId: exampleAwsVpc.id,
enabledAnalysisTypes: [
"TLS_SNI",
"HTTP_HOST",
],
subnetMappings: [{
subnetId: exampleAwsSubnet.id,
}],
tags: {
Tag1: "Value1",
Tag2: "Value2",
},
});
import pulumi
import pulumi_aws as aws
example = aws.networkfirewall.Firewall("example",
name="example",
firewall_policy_arn=example_aws_networkfirewall_firewall_policy["arn"],
vpc_id=example_aws_vpc["id"],
enabled_analysis_types=[
"TLS_SNI",
"HTTP_HOST",
],
subnet_mappings=[{
"subnet_id": example_aws_subnet["id"],
}],
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{
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"),
},
SubnetMappings: networkfirewall.FirewallSubnetMappingArray{
&networkfirewall.FirewallSubnetMappingArgs{
SubnetId: pulumi.Any(exampleAwsSubnet.Id),
},
},
Tags: pulumi.StringMap{
"Tag1": pulumi.String("Value1"),
"Tag2": pulumi.String("Value2"),
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "example",
FirewallPolicyArn = exampleAwsNetworkfirewallFirewallPolicy.Arn,
VpcId = exampleAwsVpc.Id,
EnabledAnalysisTypes = new[]
{
"TLS_SNI",
"HTTP_HOST",
},
SubnetMappings = new[]
{
new Aws.NetworkFirewall.Inputs.FirewallSubnetMappingArgs
{
SubnetId = exampleAwsSubnet.Id,
},
},
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 java.util.List;
import java.util.ArrayList;
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()
.name("example")
.firewallPolicyArn(exampleAwsNetworkfirewallFirewallPolicy.arn())
.vpcId(exampleAwsVpc.id())
.enabledAnalysisTypes(
"TLS_SNI",
"HTTP_HOST")
.subnetMappings(FirewallSubnetMappingArgs.builder()
.subnetId(exampleAwsSubnet.id())
.build())
.tags(Map.ofEntries(
Map.entry("Tag1", "Value1"),
Map.entry("Tag2", "Value2")
))
.build());
}
}
resources:
example:
type: aws:networkfirewall:Firewall
properties:
name: example
firewallPolicyArn: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
vpcId: ${exampleAwsVpc.id}
enabledAnalysisTypes:
- TLS_SNI
- HTTP_HOST
subnetMappings:
- subnetId: ${exampleAwsSubnet.id}
tags:
Tag1: Value1
Tag2: Value2
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", {
name: "example",
firewallPolicyArn: exampleAwsNetworkfirewallFirewallPolicy.arn,
transitGatewayId: exampleAwsEc2TransitGateway.id,
availabilityZoneMappings: [
{
availabilityZoneId: example.then(example => example.zoneIds?.[0]),
},
{
availabilityZoneId: example.then(example => example.zoneIds?.[1]),
},
],
});
import pulumi
import pulumi_aws as aws
example = aws.get_availability_zones(state="available")
example_firewall = aws.networkfirewall.Firewall("example",
name="example",
firewall_policy_arn=example_aws_networkfirewall_firewall_policy["arn"],
transit_gateway_id=example_aws_ec2_transit_gateway["id"],
availability_zone_mappings=[
{
"availability_zone_id": example.zone_ids[0],
},
{
"availability_zone_id": example.zone_ids[1],
},
])
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{
Name: pulumi.String("example"),
FirewallPolicyArn: pulumi.Any(exampleAwsNetworkfirewallFirewallPolicy.Arn),
TransitGatewayId: pulumi.Any(exampleAwsEc2TransitGateway.Id),
AvailabilityZoneMappings: networkfirewall.FirewallAvailabilityZoneMappingArray{
&networkfirewall.FirewallAvailabilityZoneMappingArgs{
AvailabilityZoneId: pulumi.String(example.ZoneIds[0]),
},
&networkfirewall.FirewallAvailabilityZoneMappingArgs{
AvailabilityZoneId: pulumi.String(example.ZoneIds[1]),
},
},
})
if err != nil {
return err
}
return nil
})
}
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()
{
Name = "example",
FirewallPolicyArn = exampleAwsNetworkfirewallFirewallPolicy.Arn,
TransitGatewayId = exampleAwsEc2TransitGateway.Id,
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]),
},
},
});
});
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.List;
import java.util.ArrayList;
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()
.name("example")
.firewallPolicyArn(exampleAwsNetworkfirewallFirewallPolicy.arn())
.transitGatewayId(exampleAwsEc2TransitGateway.id())
.availabilityZoneMappings(
FirewallAvailabilityZoneMappingArgs.builder()
.availabilityZoneId(example.zoneIds()[0])
.build(),
FirewallAvailabilityZoneMappingArgs.builder()
.availabilityZoneId(example.zoneIds()[1])
.build())
.build());
}
}
resources:
exampleFirewall:
type: aws:networkfirewall:Firewall
name: example
properties:
name: example
firewallPolicyArn: ${exampleAwsNetworkfirewallFirewallPolicy.arn}
transitGatewayId: ${exampleAwsEc2TransitGateway.id}
availabilityZoneMappings:
- availabilityZoneId: ${example.zoneIds[0]}
- availabilityZoneId: ${example.zoneIds[1]}
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_network_firewall_transit_gateway_attachment_accepter
resources can be found in the ./examples/network-firewall-cross-account-transit-gateway
directory within the Github Repository
Create Firewall Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Firewall(name: string, args: FirewallArgs, opts?: CustomResourceOptions);
@overload
def Firewall(resource_name: str,
args: FirewallArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Firewall(resource_name: str,
opts: Optional[ResourceOptions] = None,
firewall_policy_arn: Optional[str] = None,
description: Optional[str] = None,
name: Optional[str] = None,
availability_zone_change_protection: Optional[bool] = None,
enabled_analysis_types: Optional[Sequence[str]] = None,
encryption_configuration: Optional[FirewallEncryptionConfigurationArgs] = None,
availability_zone_mappings: Optional[Sequence[FirewallAvailabilityZoneMappingArgs]] = None,
firewall_policy_change_protection: Optional[bool] = None,
delete_protection: Optional[bool] = None,
region: Optional[str] = None,
subnet_change_protection: Optional[bool] = None,
subnet_mappings: Optional[Sequence[FirewallSubnetMappingArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
transit_gateway_id: Optional[str] = None,
vpc_id: Optional[str] = None)
func NewFirewall(ctx *Context, name string, args FirewallArgs, opts ...ResourceOption) (*Firewall, error)
public Firewall(string name, FirewallArgs args, CustomResourceOptions? opts = null)
public Firewall(String name, FirewallArgs args)
public Firewall(String name, FirewallArgs args, CustomResourceOptions options)
type: aws:networkfirewall:Firewall
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args FirewallArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args FirewallArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args FirewallArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args FirewallArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args FirewallArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var firewallResource = new Aws.NetworkFirewall.Firewall("firewallResource", new()
{
FirewallPolicyArn = "string",
Description = "string",
Name = "string",
AvailabilityZoneChangeProtection = false,
EnabledAnalysisTypes = new[]
{
"string",
},
EncryptionConfiguration = new Aws.NetworkFirewall.Inputs.FirewallEncryptionConfigurationArgs
{
Type = "string",
KeyId = "string",
},
AvailabilityZoneMappings = new[]
{
new Aws.NetworkFirewall.Inputs.FirewallAvailabilityZoneMappingArgs
{
AvailabilityZoneId = "string",
},
},
FirewallPolicyChangeProtection = false,
DeleteProtection = false,
Region = "string",
SubnetChangeProtection = false,
SubnetMappings = new[]
{
new Aws.NetworkFirewall.Inputs.FirewallSubnetMappingArgs
{
SubnetId = "string",
IpAddressType = "string",
},
},
Tags =
{
{ "string", "string" },
},
TransitGatewayId = "string",
VpcId = "string",
});
example, err := networkfirewall.NewFirewall(ctx, "firewallResource", &networkfirewall.FirewallArgs{
FirewallPolicyArn: pulumi.String("string"),
Description: pulumi.String("string"),
Name: pulumi.String("string"),
AvailabilityZoneChangeProtection: pulumi.Bool(false),
EnabledAnalysisTypes: pulumi.StringArray{
pulumi.String("string"),
},
EncryptionConfiguration: &networkfirewall.FirewallEncryptionConfigurationArgs{
Type: pulumi.String("string"),
KeyId: pulumi.String("string"),
},
AvailabilityZoneMappings: networkfirewall.FirewallAvailabilityZoneMappingArray{
&networkfirewall.FirewallAvailabilityZoneMappingArgs{
AvailabilityZoneId: pulumi.String("string"),
},
},
FirewallPolicyChangeProtection: pulumi.Bool(false),
DeleteProtection: pulumi.Bool(false),
Region: pulumi.String("string"),
SubnetChangeProtection: pulumi.Bool(false),
SubnetMappings: networkfirewall.FirewallSubnetMappingArray{
&networkfirewall.FirewallSubnetMappingArgs{
SubnetId: pulumi.String("string"),
IpAddressType: pulumi.String("string"),
},
},
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
TransitGatewayId: pulumi.String("string"),
VpcId: pulumi.String("string"),
})
var firewallResource = new Firewall("firewallResource", FirewallArgs.builder()
.firewallPolicyArn("string")
.description("string")
.name("string")
.availabilityZoneChangeProtection(false)
.enabledAnalysisTypes("string")
.encryptionConfiguration(FirewallEncryptionConfigurationArgs.builder()
.type("string")
.keyId("string")
.build())
.availabilityZoneMappings(FirewallAvailabilityZoneMappingArgs.builder()
.availabilityZoneId("string")
.build())
.firewallPolicyChangeProtection(false)
.deleteProtection(false)
.region("string")
.subnetChangeProtection(false)
.subnetMappings(FirewallSubnetMappingArgs.builder()
.subnetId("string")
.ipAddressType("string")
.build())
.tags(Map.of("string", "string"))
.transitGatewayId("string")
.vpcId("string")
.build());
firewall_resource = aws.networkfirewall.Firewall("firewallResource",
firewall_policy_arn="string",
description="string",
name="string",
availability_zone_change_protection=False,
enabled_analysis_types=["string"],
encryption_configuration={
"type": "string",
"key_id": "string",
},
availability_zone_mappings=[{
"availability_zone_id": "string",
}],
firewall_policy_change_protection=False,
delete_protection=False,
region="string",
subnet_change_protection=False,
subnet_mappings=[{
"subnet_id": "string",
"ip_address_type": "string",
}],
tags={
"string": "string",
},
transit_gateway_id="string",
vpc_id="string")
const firewallResource = new aws.networkfirewall.Firewall("firewallResource", {
firewallPolicyArn: "string",
description: "string",
name: "string",
availabilityZoneChangeProtection: false,
enabledAnalysisTypes: ["string"],
encryptionConfiguration: {
type: "string",
keyId: "string",
},
availabilityZoneMappings: [{
availabilityZoneId: "string",
}],
firewallPolicyChangeProtection: false,
deleteProtection: false,
region: "string",
subnetChangeProtection: false,
subnetMappings: [{
subnetId: "string",
ipAddressType: "string",
}],
tags: {
string: "string",
},
transitGatewayId: "string",
vpcId: "string",
});
type: aws:networkfirewall:Firewall
properties:
availabilityZoneChangeProtection: false
availabilityZoneMappings:
- availabilityZoneId: string
deleteProtection: false
description: string
enabledAnalysisTypes:
- string
encryptionConfiguration:
keyId: string
type: string
firewallPolicyArn: string
firewallPolicyChangeProtection: false
name: string
region: string
subnetChangeProtection: false
subnetMappings:
- ipAddressType: string
subnetId: string
tags:
string: string
transitGatewayId: string
vpcId: string
Firewall Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Firewall resource accepts the following input properties:
- Firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- Availability
Zone boolChange Protection - 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. - Availability
Zone List<FirewallMappings Availability Zone Mapping> - 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.
- Delete
Protection 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
. - Description string
- A friendly description of the firewall.
- Enabled
Analysis List<string>Types - 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[]
. - Encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- Firewall
Policy boolChange Protection - 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
. - Name string
- A friendly name of the firewall.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Subnet
Change boolProtection - 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
. - Subnet
Mappings List<FirewallSubnet Mapping> - 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.
- Dictionary<string, string>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Transit
Gateway stringId - . 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
- Vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- Firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- Availability
Zone boolChange Protection - 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. - Availability
Zone []FirewallMappings Availability Zone Mapping Args - 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.
- Delete
Protection 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
. - Description string
- A friendly description of the firewall.
- Enabled
Analysis []stringTypes - 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[]
. - Encryption
Configuration FirewallEncryption Configuration Args - KMS encryption configuration settings. See Encryption Configuration below for details.
- Firewall
Policy boolChange Protection - 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
. - Name string
- A friendly name of the firewall.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Subnet
Change boolProtection - 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
. - Subnet
Mappings []FirewallSubnet Mapping Args - 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.
- map[string]string
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Transit
Gateway stringId - . 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
- Vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- firewall
Policy StringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- availability
Zone BooleanChange Protection - 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. - availability
Zone List<FirewallMappings Availability Zone Mapping> - 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.
- delete
Protection Boolean - 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
. - description String
- A friendly description of the firewall.
- enabled
Analysis List<String>Types - 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[]
. - encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy BooleanChange Protection - 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
. - name String
- A friendly name of the firewall.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change BooleanProtection - 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
. - subnet
Mappings List<FirewallSubnet Mapping> - 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.
- Map<String,String>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - transit
Gateway StringId - . 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
- vpc
Id String - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- availability
Zone booleanChange Protection - 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. - availability
Zone FirewallMappings Availability Zone Mapping[] - 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.
- delete
Protection boolean - 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
. - description string
- A friendly description of the firewall.
- enabled
Analysis string[]Types - 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[]
. - encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy booleanChange Protection - 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
. - name string
- A friendly name of the firewall.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change booleanProtection - 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
. - subnet
Mappings FirewallSubnet Mapping[] - 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.
- {[key: string]: string}
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - transit
Gateway stringId - . 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
- vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- firewall_
policy_ strarn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- availability_
zone_ boolchange_ protection - 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. - availability_
zone_ Sequence[Firewallmappings Availability Zone Mapping Args] - 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.
- delete_
protection 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
. - description str
- A friendly description of the firewall.
- enabled_
analysis_ Sequence[str]types - 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[]
. - encryption_
configuration FirewallEncryption Configuration Args - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall_
policy_ boolchange_ protection - 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
. - name str
- A friendly name of the firewall.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet_
change_ boolprotection - 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
. - subnet_
mappings Sequence[FirewallSubnet Mapping Args] - 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.
- Mapping[str, str]
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - transit_
gateway_ strid - . 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
- vpc_
id str - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- firewall
Policy StringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- availability
Zone BooleanChange Protection - 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. - availability
Zone List<Property Map>Mappings - 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.
- delete
Protection Boolean - 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
. - description String
- A friendly description of the firewall.
- enabled
Analysis List<String>Types - 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[]
. - encryption
Configuration Property Map - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy BooleanChange Protection - 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
. - name String
- A friendly name of the firewall.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change BooleanProtection - 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
. - subnet
Mappings List<Property Map> - 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.
- Map<String>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - transit
Gateway StringId - . 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
- vpc
Id String - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
Outputs
All input properties are implicitly available as output properties. Additionally, the Firewall resource produces the following output properties:
- Arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- Firewall
Statuses List<FirewallFirewall Status> - Nested list of information about the current status of the firewall.
- Id string
- The provider-assigned unique ID for this managed resource.
- Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- Update
Token string - A string token used when updating a firewall.
- Arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- Firewall
Statuses []FirewallFirewall Status - Nested list of information about the current status of the firewall.
- Id string
- The provider-assigned unique ID for this managed resource.
- map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- Update
Token string - A string token used when updating a firewall.
- arn String
- The Amazon Resource Name (ARN) that identifies the firewall.
- firewall
Statuses List<FirewallFirewall Status> - Nested list of information about the current status of the firewall.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway StringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token String - A string token used when updating a firewall.
- arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- firewall
Statuses FirewallFirewall Status[] - Nested list of information about the current status of the firewall.
- id string
- The provider-assigned unique ID for this managed resource.
- {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token string - A string token used when updating a firewall.
- arn str
- The Amazon Resource Name (ARN) that identifies the firewall.
- firewall_
statuses Sequence[FirewallFirewall Status] - Nested list of information about the current status of the firewall.
- id str
- The provider-assigned unique ID for this managed resource.
- Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit_
gateway_ strowner_ account_ id - The AWS account ID that owns the transit gateway.
- update_
token str - A string token used when updating a firewall.
- arn String
- The Amazon Resource Name (ARN) that identifies the firewall.
- firewall
Statuses List<Property Map> - Nested list of information about the current status of the firewall.
- id String
- The provider-assigned unique ID for this managed resource.
- Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway StringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token String - A string token used when updating a firewall.
Look up Existing Firewall Resource
Get an existing Firewall resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: FirewallState, opts?: CustomResourceOptions): Firewall
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
arn: Optional[str] = None,
availability_zone_change_protection: Optional[bool] = None,
availability_zone_mappings: Optional[Sequence[FirewallAvailabilityZoneMappingArgs]] = None,
delete_protection: Optional[bool] = None,
description: Optional[str] = None,
enabled_analysis_types: Optional[Sequence[str]] = None,
encryption_configuration: Optional[FirewallEncryptionConfigurationArgs] = None,
firewall_policy_arn: Optional[str] = None,
firewall_policy_change_protection: Optional[bool] = None,
firewall_statuses: Optional[Sequence[FirewallFirewallStatusArgs]] = None,
name: Optional[str] = None,
region: Optional[str] = None,
subnet_change_protection: Optional[bool] = None,
subnet_mappings: Optional[Sequence[FirewallSubnetMappingArgs]] = None,
tags: Optional[Mapping[str, str]] = None,
tags_all: Optional[Mapping[str, str]] = None,
transit_gateway_id: Optional[str] = None,
transit_gateway_owner_account_id: Optional[str] = None,
update_token: Optional[str] = None,
vpc_id: Optional[str] = None) -> Firewall
func GetFirewall(ctx *Context, name string, id IDInput, state *FirewallState, opts ...ResourceOption) (*Firewall, error)
public static Firewall Get(string name, Input<string> id, FirewallState? state, CustomResourceOptions? opts = null)
public static Firewall get(String name, Output<String> id, FirewallState state, CustomResourceOptions options)
resources: _: type: aws:networkfirewall:Firewall get: id: ${id}
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- Availability
Zone boolChange Protection - 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. - Availability
Zone List<FirewallMappings Availability Zone Mapping> - 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.
- Delete
Protection 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
. - Description string
- A friendly description of the firewall.
- Enabled
Analysis List<string>Types - 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[]
. - Encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- Firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- Firewall
Policy boolChange Protection - 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
. - Firewall
Statuses List<FirewallFirewall Status> - Nested list of information about the current status of the firewall.
- Name string
- A friendly name of the firewall.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Subnet
Change boolProtection - 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
. - Subnet
Mappings List<FirewallSubnet Mapping> - 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.
- Dictionary<string, string>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Dictionary<string, string>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Transit
Gateway stringId - . 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
- Transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- Update
Token string - A string token used when updating a firewall.
- Vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- Arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- Availability
Zone boolChange Protection - 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. - Availability
Zone []FirewallMappings Availability Zone Mapping Args - 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.
- Delete
Protection 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
. - Description string
- A friendly description of the firewall.
- Enabled
Analysis []stringTypes - 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[]
. - Encryption
Configuration FirewallEncryption Configuration Args - KMS encryption configuration settings. See Encryption Configuration below for details.
- Firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- Firewall
Policy boolChange Protection - 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
. - Firewall
Statuses []FirewallFirewall Status Args - Nested list of information about the current status of the firewall.
- Name string
- A friendly name of the firewall.
- Region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- Subnet
Change boolProtection - 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
. - Subnet
Mappings []FirewallSubnet Mapping Args - 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.
- map[string]string
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - map[string]string
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - Transit
Gateway stringId - . 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
- Transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- Update
Token string - A string token used when updating a firewall.
- Vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- arn String
- The Amazon Resource Name (ARN) that identifies the firewall.
- availability
Zone BooleanChange Protection - 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. - availability
Zone List<FirewallMappings Availability Zone Mapping> - 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.
- delete
Protection Boolean - 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
. - description String
- A friendly description of the firewall.
- enabled
Analysis List<String>Types - 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[]
. - encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy StringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- firewall
Policy BooleanChange Protection - 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
. - firewall
Statuses List<FirewallFirewall Status> - Nested list of information about the current status of the firewall.
- name String
- A friendly name of the firewall.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change BooleanProtection - 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
. - subnet
Mappings List<FirewallSubnet Mapping> - 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.
- Map<String,String>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String,String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway StringId - . 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
- transit
Gateway StringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token String - A string token used when updating a firewall.
- vpc
Id String - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- arn string
- The Amazon Resource Name (ARN) that identifies the firewall.
- availability
Zone booleanChange Protection - 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. - availability
Zone FirewallMappings Availability Zone Mapping[] - 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.
- delete
Protection boolean - 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
. - description string
- A friendly description of the firewall.
- enabled
Analysis string[]Types - 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[]
. - encryption
Configuration FirewallEncryption Configuration - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy stringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- firewall
Policy booleanChange Protection - 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
. - firewall
Statuses FirewallFirewall Status[] - Nested list of information about the current status of the firewall.
- name string
- A friendly name of the firewall.
- region string
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change booleanProtection - 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
. - subnet
Mappings FirewallSubnet Mapping[] - 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.
- {[key: string]: string}
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - {[key: string]: string}
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway stringId - . 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
- transit
Gateway stringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token string - A string token used when updating a firewall.
- vpc
Id string - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- arn str
- The Amazon Resource Name (ARN) that identifies the firewall.
- availability_
zone_ boolchange_ protection - 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. - availability_
zone_ Sequence[Firewallmappings Availability Zone Mapping Args] - 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.
- delete_
protection 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
. - description str
- A friendly description of the firewall.
- enabled_
analysis_ Sequence[str]types - 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[]
. - encryption_
configuration FirewallEncryption Configuration Args - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall_
policy_ strarn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- firewall_
policy_ boolchange_ protection - 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
. - firewall_
statuses Sequence[FirewallFirewall Status Args] - Nested list of information about the current status of the firewall.
- name str
- A friendly name of the firewall.
- region str
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet_
change_ boolprotection - 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
. - subnet_
mappings Sequence[FirewallSubnet Mapping Args] - 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.
- Mapping[str, str]
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Mapping[str, str]
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit_
gateway_ strid - . 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
- transit_
gateway_ strowner_ account_ id - The AWS account ID that owns the transit gateway.
- update_
token str - A string token used when updating a firewall.
- vpc_
id str - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
- arn String
- The Amazon Resource Name (ARN) that identifies the firewall.
- availability
Zone BooleanChange Protection - 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. - availability
Zone List<Property Map>Mappings - 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.
- delete
Protection Boolean - 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
. - description String
- A friendly description of the firewall.
- enabled
Analysis List<String>Types - 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[]
. - encryption
Configuration Property Map - KMS encryption configuration settings. See Encryption Configuration below for details.
- firewall
Policy StringArn - The Amazon Resource Name (ARN) of the VPC Firewall policy.
- firewall
Policy BooleanChange Protection - 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
. - firewall
Statuses List<Property Map> - Nested list of information about the current status of the firewall.
- name String
- A friendly name of the firewall.
- region String
- Region where this resource will be managed. Defaults to the Region set in the provider configuration.
- subnet
Change BooleanProtection - 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
. - subnet
Mappings List<Property Map> - 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.
- Map<String>
- Map of resource tags to associate with the resource. If configured with a provider
default_tags
configuration block present, tags with matching keys will overwrite those defined at the provider-level. - Map<String>
- A map of tags assigned to the resource, including those inherited from the provider
default_tags
configuration block. - transit
Gateway StringId - . 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
- transit
Gateway StringOwner Account Id - The AWS account ID that owns the transit gateway.
- update
Token String - A string token used when updating a firewall.
- vpc
Id String - Required when creating a VPC attached firewall. The unique identifier of the VPC where AWS Network Firewall should create the firewall.
Supporting Types
FirewallAvailabilityZoneMapping, FirewallAvailabilityZoneMappingArgs
- Availability
Zone stringId - The ID of the Availability Zone where the firewall endpoint is located..
- Availability
Zone stringId - The ID of the Availability Zone where the firewall endpoint is located..
- availability
Zone StringId - The ID of the Availability Zone where the firewall endpoint is located..
- availability
Zone stringId - The ID of the Availability Zone where the firewall endpoint is located..
- availability_
zone_ strid - The ID of the Availability Zone where the firewall endpoint is located..
- availability
Zone StringId - The ID of the Availability Zone where the firewall endpoint is located..
FirewallEncryptionConfiguration, FirewallEncryptionConfigurationArgs
- Type string
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - Key
Id string - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
- Type string
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - Key
Id string - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
- type String
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - key
Id String - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
- type string
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - key
Id string - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
- type str
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - key_
id str - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
- type String
- The type of AWS KMS key to use for encryption of your Network Firewall resources. Valid values are
CUSTOMER_KMS
andAWS_OWNED_KMS_KEY
. - key
Id String - The ID of the customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN.
FirewallFirewallStatus, FirewallFirewallStatusArgs
- Sync
States List<FirewallFirewall Status Sync State> - Set of subnets configured for use by the firewall.
- Transit
Gateway List<FirewallAttachment Sync States Firewall Status Transit Gateway Attachment Sync State> - Set of transit gateway configured for use by the firewall.
- Sync
States []FirewallFirewall Status Sync State - Set of subnets configured for use by the firewall.
- Transit
Gateway []FirewallAttachment Sync States Firewall Status Transit Gateway Attachment Sync State - Set of transit gateway configured for use by the firewall.
- sync
States List<FirewallFirewall Status Sync State> - Set of subnets configured for use by the firewall.
- transit
Gateway List<FirewallAttachment Sync States Firewall Status Transit Gateway Attachment Sync State> - Set of transit gateway configured for use by the firewall.
- sync
States FirewallFirewall Status Sync State[] - Set of subnets configured for use by the firewall.
- transit
Gateway FirewallAttachment Sync States Firewall Status Transit Gateway Attachment Sync State[] - Set of transit gateway configured for use by the firewall.
- sync_
states Sequence[FirewallFirewall Status Sync State] - Set of subnets configured for use by the firewall.
- transit_
gateway_ Sequence[Firewallattachment_ sync_ states Firewall Status Transit Gateway Attachment Sync State] - Set of transit gateway configured for use by the firewall.
- sync
States List<Property Map> - Set of subnets configured for use by the firewall.
- transit
Gateway List<Property Map>Attachment Sync States - Set of transit gateway configured for use by the firewall.
FirewallFirewallStatusSyncState, FirewallFirewallStatusSyncStateArgs
- Attachments
List<Firewall
Firewall Status Sync State Attachment> - Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- Availability
Zone string - The Availability Zone where the subnet is configured.
- Attachments
[]Firewall
Firewall Status Sync State Attachment - Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- Availability
Zone string - The Availability Zone where the subnet is configured.
- attachments
List<Firewall
Firewall Status Sync State Attachment> - Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- availability
Zone String - The Availability Zone where the subnet is configured.
- attachments
Firewall
Firewall Status Sync State Attachment[] - Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- availability
Zone string - The Availability Zone where the subnet is configured.
- attachments
Sequence[Firewall
Firewall Status Sync State Attachment] - Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- availability_
zone str - The Availability Zone where the subnet is configured.
- attachments List<Property Map>
- Nested list describing the attachment status of the firewall's association with a single VPC subnet.
- availability
Zone String - The Availability Zone where the subnet is configured.
FirewallFirewallStatusSyncStateAttachment, FirewallFirewallStatusSyncStateAttachmentArgs
- Endpoint
Id string - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- Subnet
Id string - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- Endpoint
Id string - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- Subnet
Id string - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- endpoint
Id String - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- subnet
Id String - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- endpoint
Id string - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- subnet
Id string - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- endpoint_
id str - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- subnet_
id str - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
- endpoint
Id String - The identifier of the firewall endpoint that AWS Network Firewall has instantiated in the subnet. You use this to identify the firewall endpoint in the VPC route tables, when you redirect the VPC traffic through the endpoint.
- subnet
Id String - The unique identifier of the subnet that you've specified to be used for a firewall endpoint.
FirewallFirewallStatusTransitGatewayAttachmentSyncState, FirewallFirewallStatusTransitGatewayAttachmentSyncStateArgs
- Attachment
Id string - The unique identifier of the transit gateway attachment.
- Attachment
Id string - The unique identifier of the transit gateway attachment.
- attachment
Id String - The unique identifier of the transit gateway attachment.
- attachment
Id string - The unique identifier of the transit gateway attachment.
- attachment_
id str - The unique identifier of the transit gateway attachment.
- attachment
Id String - The unique identifier of the transit gateway attachment.
FirewallSubnetMapping, FirewallSubnetMappingArgs
- Subnet
Id string - The unique identifier for the subnet.
- Ip
Address stringType - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
- Subnet
Id string - The unique identifier for the subnet.
- Ip
Address stringType - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
- subnet
Id String - The unique identifier for the subnet.
- ip
Address StringType - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
- subnet
Id string - The unique identifier for the subnet.
- ip
Address stringType - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
- subnet_
id str - The unique identifier for the subnet.
- ip_
address_ strtype - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
- subnet
Id String - The unique identifier for the subnet.
- ip
Address StringType - The subnet's IP address type. Valid values:
"DUALSTACK"
,"IPV4"
.
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
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
aws
Terraform Provider.