We recommend new projects start with resources from the AWS provider.
aws-native.networkfirewall.Firewall
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource type definition for AWS::NetworkFirewall::Firewall
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,
subnet_mappings: Optional[Sequence[FirewallSubnetMappingArgs]] = None,
vpc_id: Optional[str] = None,
delete_protection: Optional[bool] = None,
description: Optional[str] = None,
firewall_name: Optional[str] = None,
firewall_policy_change_protection: Optional[bool] = None,
subnet_change_protection: Optional[bool] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = 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-native:networkfirewall:Firewall
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FirewallArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. 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
This property is required. string - The unique name of the resource.
- args
This property is required. FirewallArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. FirewallArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. FirewallArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
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 Arn This property is required. string The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- Subnet
Mappings This property is required. List<Pulumi.Aws Native. Network Firewall. Inputs. Firewall Subnet Mapping> - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- Vpc
Id This property is required. string - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- Delete
Protection bool - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - Description string
- A description of the firewall.
- Firewall
Name string - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- Firewall
Policy boolChange Protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - Subnet
Change boolProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - List<Pulumi.
Aws Native. Inputs. Tag> An array of key-value pairs to apply to this resource.
For more information, see Tag .
- Firewall
Policy Arn This property is required. string The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- Subnet
Mappings This property is required. []FirewallSubnet Mapping Args - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- Vpc
Id This property is required. string - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- Delete
Protection bool - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - Description string
- A description of the firewall.
- Firewall
Name string - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- Firewall
Policy boolChange Protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - Subnet
Change boolProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - Tag
Args An array of key-value pairs to apply to this resource.
For more information, see Tag .
- firewall
Policy Arn This property is required. String The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- subnet
Mappings This property is required. List<FirewallSubnet Mapping> - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- vpc
Id This property is required. String - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- delete
Protection Boolean - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - description String
- A description of the firewall.
- firewall
Name String - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- firewall
Policy BooleanChange Protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - subnet
Change BooleanProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - List<Tag>
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- firewall
Policy Arn This property is required. string The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- subnet
Mappings This property is required. FirewallSubnet Mapping[] - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- vpc
Id This property is required. string - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- delete
Protection boolean - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - description string
- A description of the firewall.
- firewall
Name string - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- firewall
Policy booleanChange Protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - subnet
Change booleanProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - Tag[]
An array of key-value pairs to apply to this resource.
For more information, see Tag .
- firewall_
policy_ arn This property is required. str The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- subnet_
mappings This property is required. Sequence[FirewallSubnet Mapping Args] - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- vpc_
id This property is required. str - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- delete_
protection bool - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - description str
- A description of the firewall.
- firewall_
name str - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- firewall_
policy_ boolchange_ protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - subnet_
change_ boolprotection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - Sequence[Tag
Args] An array of key-value pairs to apply to this resource.
For more information, see Tag .
- firewall
Policy Arn This property is required. String The Amazon Resource Name (ARN) of the firewall policy.
The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls.
- subnet
Mappings This property is required. List<Property Map> - The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
- vpc
Id This property is required. String - The unique identifier of the VPC where the firewall is in use. You can't change the VPC of a firewall after you create the firewall.
- delete
Protection Boolean - A flag indicating whether it is possible to delete the firewall. A setting of
TRUE
indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag toTRUE
. - description String
- A description of the firewall.
- firewall
Name String - The descriptive name of the firewall. You can't change the name of a firewall after you create it.
- firewall
Policy BooleanChange Protection - A setting indicating whether the firewall is protected against a change to the firewall policy association. Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - subnet
Change BooleanProtection - A setting indicating whether the firewall is protected against changes to the subnet associations. Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to
TRUE
. - List<Property Map>
An array of key-value pairs to apply to this resource.
For more information, see Tag .
Outputs
All input properties are implicitly available as output properties. Additionally, the Firewall resource produces the following output properties:
- Endpoint
Ids List<string> - 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"]
. - Firewall
Arn string - The Amazon Resource Name (ARN) of the
Firewall
. - Firewall
Id string - The name of the
Firewall
resource. - Id string
- The provider-assigned unique ID for this managed resource.
- Endpoint
Ids []string - 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"]
. - Firewall
Arn string - The Amazon Resource Name (ARN) of the
Firewall
. - Firewall
Id string - The name of the
Firewall
resource. - Id string
- The provider-assigned unique ID for this managed resource.
- endpoint
Ids List<String> - 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"]
. - firewall
Arn String - The Amazon Resource Name (ARN) of the
Firewall
. - firewall
Id String - The name of the
Firewall
resource. - id String
- The provider-assigned unique ID for this managed resource.
- endpoint
Ids string[] - 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"]
. - firewall
Arn string - The Amazon Resource Name (ARN) of the
Firewall
. - firewall
Id string - The name of the
Firewall
resource. - id string
- The provider-assigned unique ID for this managed resource.
- endpoint_
ids Sequence[str] - 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"]
. - firewall_
arn str - The Amazon Resource Name (ARN) of the
Firewall
. - firewall_
id str - The name of the
Firewall
resource. - id str
- The provider-assigned unique ID for this managed resource.
- endpoint
Ids List<String> - 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"]
. - firewall
Arn String - The Amazon Resource Name (ARN) of the
Firewall
. - firewall
Id String - The name of the
Firewall
resource. - id String
- The provider-assigned unique ID for this managed resource.
Supporting Types
FirewallSubnetMapping, FirewallSubnetMappingArgs
- Subnet
Id This property is required. string - A SubnetId.
- Ip
Address stringType - A IPAddressType
- Subnet
Id This property is required. string - A SubnetId.
- Ip
Address stringType - A IPAddressType
- subnet
Id This property is required. String - A SubnetId.
- ip
Address StringType - A IPAddressType
- subnet
Id This property is required. string - A SubnetId.
- ip
Address stringType - A IPAddressType
- subnet_
id This property is required. str - A SubnetId.
- ip_
address_ strtype - A IPAddressType
- subnet
Id This property is required. String - A SubnetId.
- ip
Address StringType - A IPAddressType
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.