Firewall
The firewall defines the configuration settings for an AWS Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
The status of the firewall, for example whether it's ready to filter network traffic, is provided in the corresponding FirewallStatus. You can retrieve both objects by calling DescribeFirewall.
Contents
- FirewallId
-
The unique identifier for the firewall.
Type: String
Length Constraints: Fixed length of 36.
Pattern:
^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$Required: Yes
- FirewallPolicyArn
-
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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: Yes
- SubnetMappings
-
The public subnets that Network Firewall is using for the firewall. Each subnet must belong to a different Availability Zone.
Type: Array of SubnetMapping objects
Required: Yes
- VpcId
-
The unique identifier of the VPC where the firewall is in use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^vpc-[0-9a-f]+$Required: Yes
- DeleteProtection
-
A flag indicating whether it is possible to delete the firewall. A setting of
TRUEindicates 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.Type: Boolean
Required: No
- Description
-
A description of the firewall.
Type: String
Length Constraints: Maximum length of 512.
Pattern:
^.*$Required: No
- EncryptionConfiguration
-
A complex type that contains the AWS KMS encryption configuration settings for your firewall.
Type: EncryptionConfiguration object
Required: No
- FirewallArn
-
The Amazon Resource Name (ARN) of the firewall.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^arn:aws.*Required: No
- FirewallName
-
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
^[a-zA-Z0-9-]+$Required: No
- FirewallPolicyChangeProtection
-
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.Type: Boolean
Required: No
- SubnetChangeProtection
-
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.Type: Boolean
Required: No
- Tags
-
Type: Array of Tag objects
Array Members: Minimum number of 1 item. Maximum number of 200 items.
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
