Firewall
¶
Source code in docs_src/capo_network_firewall/types/firewall.py
availability_zone_change_protection
instance-attribute
¶
availability_zone_change_protection: Boolean
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_mappings
instance-attribute
¶
availability_zone_mappings: NotRequired[AvailabilityZoneMappings]
The Availability Zones where the firewall endpoints are created for a transit gateway-attached firewall. Each mapping specifies an Availability Zone where the firewall processes traffic.
delete_protection
instance-attribute
¶
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 to TRUE.
description
instance-attribute
¶
description: NotRequired[Description]
A description of the firewall.
enabled_analysis_types
instance-attribute
¶
enabled_analysis_types: NotRequired[EnabledAnalysisTypes]
An optional setting indicating the specific traffic analysis types to enable on the firewall.
encryption_configuration
instance-attribute
¶
encryption_configuration: NotRequired[EncryptionConfiguration]
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
firewall_arn
instance-attribute
¶
firewall_arn: NotRequired[ResourceArn]
The Amazon Resource Name (ARN) of the firewall.
firewall_name
instance-attribute
¶
firewall_name: NotRequired[ResourceName]
The descriptive name of the firewall. You can't change the name of a firewall after you create it.
firewall_policy_arn
instance-attribute
¶
firewall_policy_arn: ResourceArn
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.
firewall_policy_change_protection
instance-attribute
¶
firewall_policy_change_protection: Boolean
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.
nat_gateway_mappings
instance-attribute
¶
nat_gateway_mappings: NotRequired[NatGatewayMappingsList]
The NAT gateways that the firewall uses to proxy traffic. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE.
no_source_preservation
instance-attribute
¶
no_source_preservation: Boolean
Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When this value is TRUE, the firewall proxies traffic through a NAT gateway and uses the NAT gateway's IP address as the source for traffic reaching the destination.
number_of_associations
instance-attribute
¶
number_of_associations: NotRequired[NumberOfAssociations]
The number of VpcEndpointAssociation resources that use this firewall.
proxy_settings
instance-attribute
¶
proxy_settings: NotRequired[ProxySettings]
The listener configuration for the firewall's proxy. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE.
subnet_change_protection
instance-attribute
¶
subnet_change_protection: Boolean
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.
subnet_mappings
instance-attribute
¶
subnet_mappings: SubnetMappings
The primary public subnets that Network Firewall is using for the firewall. Network Firewall creates a firewall endpoint in each subnet. Create a subnet mapping for each Availability Zone where you want to use the firewall.
These subnets are all defined for a single, primary VPC, and each must belong to a different Availability Zone. Each of these subnets establishes the availability of the firewall in its Availability Zone.
In addition to these subnets, you can define other endpoints for the firewall in VpcEndpointAssociation resources. You can define these additional endpoints for any VPC, and for any of the Availability Zones where the firewall resource already has a subnet mapping. VPC endpoint associations give you the ability to protect multiple VPCs using a single firewall, and to define multiple firewall endpoints for a VPC in a single Availability Zone.
transit_gateway_id
instance-attribute
¶
transit_gateway_id: NotRequired[TransitGatewayId]
The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.
transit_gateway_owner_account_id
instance-attribute
¶
transit_gateway_owner_account_id: NotRequired[AWSAccountId]
The Amazon Web Services account ID that owns the transit gateway. This may be different from the firewall owner's account ID when using a shared transit gateway.
vpc_endpoint
instance-attribute
¶
vpc_endpoint: NotRequired[VpcEndpoint]
The VPC and subnets for the firewall endpoint. This is set for proxy mode firewalls, where NoSourcePreservation is TRUE.