Skip to content

CreateFirewallRequest

Source code in docs_src/capo_network_firewall/types/create_firewall_request.py
class CreateFirewallRequest(TypedDict, closed=True):
    firewall_name: "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_policy_arn: "capo_network_firewall.types.resource_arn.ResourceArn"
    """<p>The Amazon Resource Name (ARN) of the <a>FirewallPolicy</a> that you want to use for the firewall.</p>"""
    vpc_id: NotRequired["capo_network_firewall.types.vpc_id.VpcId"]
    """<p>The unique identifier of the VPC where Network Firewall should create the firewall. </p> <p>You can't change this setting after you create the firewall. </p>"""
    subnet_mappings: NotRequired[
        "capo_network_firewall.types.subnet_mappings.SubnetMappings"
    ]
    """<p>The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet. </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>"""
    tags: NotRequired["capo_network_firewall.types.tag_list.TagList"]
    """<p>The key:value pairs to associate with the resource.</p>"""
    encryption_configuration: NotRequired[
        "capo_network_firewall.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>A complex type that contains settings for encryption of your firewall resources.</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>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 Resource Access Manager.</p> <important> <p>After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.</p> </important> <p>For information about creating firewalls, see <a>CreateFirewall</a>. For specific guidance about transit gateway-attached firewalls, see <a href="https://docs.aws.amazon.com/network-firewall/latest/developerguide/tgw-firewall-considerations.html">Considerations for transit gateway-attached firewalls</a> in the <i>Network Firewall Developer Guide</i>.</p>"""
    availability_zone_mappings: NotRequired[
        "capo_network_firewall.types.availability_zone_mappings.AvailabilityZoneMappings"
    ]
    """<p>Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.</p> <p>You can modify Availability Zones later using <a>AssociateAvailabilityZones</a> or <a>DisassociateAvailabilityZones</a>, but this may briefly disrupt traffic. The <code>AvailabilityZoneChangeProtection</code> setting controls whether you can make these modifications.</p>"""
    availability_zone_change_protection: "capo_network_firewall.types.boolean.Boolean"
    """<p>Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to <code>TRUE</code>, you cannot add or remove Availability Zones without first disabling this protection using <a>UpdateAvailabilityZoneChangeProtection</a>.</p> <p>Default value: <code>FALSE</code> </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 when <code>NoSourcePreservation</code> is <code>TRUE</code>. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway. </p>"""
    proxy_settings: NotRequired[
        "capo_network_firewall.types.proxy_settings.ProxySettings"
    ]
    """<p>The listener configuration for a proxy mode firewall, used when <code>NoSourcePreservation</code> is <code>TRUE</code>. This specifies the ports and protocols on which the firewall's proxy listens for traffic. </p>"""
    no_source_preservation: "capo_network_firewall.types.boolean.Boolean"
    """<p>Optional. Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When set to <code>TRUE</code>, the firewall proxies traffic through a NAT gateway and the traffic reaching the destination uses the NAT gateway's IP address as the source. </p> <p>When you set this to <code>TRUE</code>, you must specify <code>NatGatewayMappings</code> and <code>VpcEndpoint</code> instead of a top-level <code>VpcId</code> and <code>SubnetMappings</code>. </p> <p>You can't change this setting after you create the firewall. </p> <p>Default value: <code>FALSE</code> </p>"""
    vpc_endpoint: NotRequired["capo_network_firewall.types.vpc_endpoint.VpcEndpoint"]
    """<p>The VPC and subnets for the firewall endpoint, used when <code>NoSourcePreservation</code> is <code>TRUE</code>. Network Firewall creates the firewall endpoint in the subnets that you specify here. </p> <p>For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level <code>VpcId</code> and <code>SubnetMappings</code>. </p>"""

availability_zone_change_protection instance-attribute

availability_zone_change_protection: Boolean

Optional. A setting indicating whether the firewall is protected against changes to its Availability Zone configuration. When set to TRUE, you cannot add or remove Availability Zones without first disabling this protection using UpdateAvailabilityZoneChangeProtection.

Default value: FALSE

availability_zone_mappings instance-attribute

availability_zone_mappings: NotRequired[AvailabilityZoneMappings]

Required. The Availability Zones where you want to create firewall endpoints for a transit gateway-attached firewall. You must specify at least one Availability Zone. Consider enabling the firewall in every Availability Zone where you have workloads to maintain Availability Zone isolation.

You can modify Availability Zones later using AssociateAvailabilityZones or DisassociateAvailabilityZones, but this may briefly disrupt traffic. The AvailabilityZoneChangeProtection setting controls whether you can make these modifications.

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 settings for encryption of your firewall resources.

firewall_name instance-attribute

firewall_name: 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 FirewallPolicy that you want to use for the firewall.

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 when NoSourcePreservation is TRUE. Network Firewall attaches the firewall to each NAT gateway that you specify, so that egress traffic is proxied through the NAT gateway.

no_source_preservation instance-attribute

no_source_preservation: Boolean

Optional. Indicates whether the firewall operates in proxy mode, in which the source IP address of the traffic is not preserved. When set to TRUE, the firewall proxies traffic through a NAT gateway and the traffic reaching the destination uses the NAT gateway's IP address as the source.

When you set this to TRUE, you must specify NatGatewayMappings and VpcEndpoint instead of a top-level VpcId and SubnetMappings.

You can't change this setting after you create the firewall.

Default value: FALSE

proxy_settings instance-attribute

proxy_settings: NotRequired[ProxySettings]

The listener configuration for a proxy mode firewall, used when NoSourcePreservation is TRUE. This specifies the ports and protocols on which the firewall's proxy listens for traffic.

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: NotRequired[SubnetMappings]

The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each subnet.

tags instance-attribute

tags: NotRequired[TagList]

The key:value pairs to associate with the resource.

transit_gateway_id instance-attribute

transit_gateway_id: NotRequired[TransitGatewayId]

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 Resource Access Manager.

After creating the firewall, you cannot change the transit gateway association. To use a different transit gateway, you must create a new firewall.

For information about creating firewalls, see CreateFirewall. For specific guidance about transit gateway-attached firewalls, see Considerations for transit gateway-attached firewalls in the Network Firewall Developer Guide.

vpc_endpoint instance-attribute

vpc_endpoint: NotRequired[VpcEndpoint]

The VPC and subnets for the firewall endpoint, used when NoSourcePreservation is TRUE. Network Firewall creates the firewall endpoint in the subnets that you specify here.

For proxy mode firewalls, provide the firewall's VPC and endpoint subnets through this parameter instead of the top-level VpcId and SubnetMappings.

vpc_id instance-attribute

vpc_id: NotRequired[VpcId]

The unique identifier of the VPC where Network Firewall should create the firewall.

You can't change this setting after you create the firewall.