Skip to content

Firewall

Source code in docs_src/capo_network_firewall/types/firewall.py
class Firewall(TypedDict, closed=True):
    firewall_name: NotRequired["capo_network_firewall.types.resource_name.ResourceName"]
    """<p>The descriptive name of the firewall. You can't change the name of a firewall after you create it.</p>"""
    firewall_arn: NotRequired["capo_network_firewall.types.resource_arn.ResourceArn"]
    """<p>The Amazon Resource Name (ARN) of the firewall.</p>"""
    firewall_policy_arn: "capo_network_firewall.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the firewall policy.</p> <p>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. </p>"""
    vpc_id: "capo_network_firewall.types.vpc_id.VpcId"
    """<p>The unique identifier of the VPC where the firewall is in use. </p>"""
    subnet_mappings: "capo_network_firewall.types.subnet_mappings.SubnetMappings"
    """<p>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.</p> <p>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. </p> <p>In addition to these subnets, you can define other endpoints for the firewall in <code>VpcEndpointAssociation</code> 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. </p>"""
    delete_protection: "capo_network_firewall.types.boolean.Boolean"
    """<p>A flag indicating whether it is possible to delete the firewall. A setting of <code>TRUE</code> 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 <code>TRUE</code>.</p>"""
    subnet_change_protection: "capo_network_firewall.types.boolean.Boolean"
    """<p>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 <code>TRUE</code>.</p>"""
    firewall_policy_change_protection: "capo_network_firewall.types.boolean.Boolean"
    """<p>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 <code>TRUE</code>.</p>"""
    description: NotRequired["capo_network_firewall.types.description.Description"]
    """<p>A description of the firewall.</p>"""
    firewall_id: "capo_network_firewall.types.resource_id.ResourceId"
    """<p>The unique identifier for the firewall. </p>"""
    tags: NotRequired["capo_network_firewall.types.tag_list.TagList"]
    """<p></p>"""
    encryption_configuration: NotRequired[
        "capo_network_firewall.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.</p>"""
    number_of_associations: NotRequired[
        "capo_network_firewall.types.number_of_associations.NumberOfAssociations"
    ]
    """<p>The number of <code>VpcEndpointAssociation</code> resources that use this firewall. </p>"""
    enabled_analysis_types: NotRequired[
        "capo_network_firewall.types.enabled_analysis_types.EnabledAnalysisTypes"
    ]
    """<p>An optional setting indicating the specific traffic analysis types to enable on the firewall. </p>"""
    transit_gateway_id: NotRequired[
        "capo_network_firewall.types.transit_gateway_id.TransitGatewayId"
    ]
    """<p>The unique identifier of the transit gateway associated with this firewall. This field is only present for transit gateway-attached firewalls.</p>"""
    transit_gateway_owner_account_id: NotRequired[
        "capo_network_firewall.types.aws_account_id.AWSAccountId"
    ]
    """<p>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.</p>"""
    availability_zone_mappings: NotRequired[
        "capo_network_firewall.types.availability_zone_mappings.AvailabilityZoneMappings"
    ]
    """<p>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.</p>"""
    availability_zone_change_protection: "capo_network_firewall.types.boolean.Boolean"
    """<p>A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to <code>TRUE</code>, you must first disable this protection before adding or removing Availability Zones.</p>"""
    nat_gateway_mappings: NotRequired[
        "capo_network_firewall.types.nat_gateway_mappings_list.NatGatewayMappingsList"
    ]
    """<p>The NAT gateways that the firewall uses to proxy traffic. This is set for proxy mode firewalls, where <code>NoSourcePreservation</code> is <code>TRUE</code>. </p>"""
    proxy_settings: NotRequired[
        "capo_network_firewall.types.proxy_settings.ProxySettings"
    ]
    """<p>The listener configuration for the firewall's proxy. This is set for proxy mode firewalls, where <code>NoSourcePreservation</code> is <code>TRUE</code>. </p>"""
    no_source_preservation: "capo_network_firewall.types.boolean.Boolean"
    """<p>Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When this value is <code>TRUE</code>, the firewall proxies traffic through a NAT gateway and uses the NAT gateway's IP address as the source for traffic reaching the destination. </p>"""
    vpc_endpoint: NotRequired["capo_network_firewall.types.vpc_endpoint.VpcEndpoint"]
    """<p>The VPC and subnets for the firewall endpoint. This is set for proxy mode firewalls, where <code>NoSourcePreservation</code> is <code>TRUE</code>. </p>"""

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_id instance-attribute

firewall_id: ResourceId

The unique identifier for 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.

tags instance-attribute

tags: NotRequired[TagList]

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.

vpc_id instance-attribute

vpc_id: VpcId

The unique identifier of the VPC where the firewall is in use.