1. Registry
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. fwcenter
  6. NatFireWall
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine
volcenginecc logo
Viewing docs for volcenginecc v0.0.60
published on Thursday, Sep 3, 2026 by Volcengine

    NAT boundary firewall instance. Provides security protection and access control for north-south traffic passing through the NAT gateway.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const example = new volcenginecc.fwcenter.NatFireWall("example", {
        natGatewayId: "ngw-xxxxxx",
        natFirewallName: "example",
        firewallCidr: "192.168.208.0/28",
        bandwidth: 100,
        projectName: "default",
        cloudFirewallId: "CloudFirewallxxxxxxxx",
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    example = volcenginecc.fwcenter.NatFireWall("example",
        nat_gateway_id="ngw-xxxxxx",
        nat_firewall_name="example",
        firewall_cidr="192.168.208.0/28",
        bandwidth=100,
        project_name="default",
        cloud_firewall_id="CloudFirewallxxxxxxxx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/fwcenter"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := fwcenter.NewNatFireWall(ctx, "example", &fwcenter.NatFireWallArgs{
    			NatGatewayId:    pulumi.String("ngw-xxxxxx"),
    			NatFirewallName: pulumi.String("example"),
    			FirewallCidr:    pulumi.String("192.168.208.0/28"),
    			Bandwidth:       pulumi.Int(100),
    			ProjectName:     pulumi.String("default"),
    			CloudFirewallId: pulumi.String("CloudFirewallxxxxxxxx"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Volcenginecc = Volcengine.Pulumi.Volcenginecc;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Volcenginecc.Fwcenter.NatFireWall("example", new()
        {
            NatGatewayId = "ngw-xxxxxx",
            NatFirewallName = "example",
            FirewallCidr = "192.168.208.0/28",
            Bandwidth = 100,
            ProjectName = "default",
            CloudFirewallId = "CloudFirewallxxxxxxxx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.fwcenter.NatFireWall;
    import com.volcengine.volcenginecc.fwcenter.NatFireWallArgs;
    import java.util.ArrayList;
    import java.util.Arrays;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new NatFireWall("example", NatFireWallArgs.builder()
                .natGatewayId("ngw-xxxxxx")
                .natFirewallName("example")
                .firewallCidr("192.168.208.0/28")
                .bandwidth(100)
                .projectName("default")
                .cloudFirewallId("CloudFirewallxxxxxxxx")
                .build());
    
        }
    }
    
    resources:
      example:
        type: volcenginecc:fwcenter:NatFireWall
        properties:
          natGatewayId: ngw-xxxxxx
          natFirewallName: example
          firewallCidr: 192.168.208.0/28
          bandwidth: 100
          projectName: default
          cloudFirewallId: CloudFirewallxxxxxxxx
    
    pulumi {
      required_providers {
        volcenginecc = {
          source = "pulumi/volcenginecc"
        }
      }
    }
    
    resource "volcenginecc_fwcenter_natfirewall" "example" {
      nat_gateway_id    = "ngw-xxxxxx"
      nat_firewall_name = "example"
      firewall_cidr     = "192.168.208.0/28"
      bandwidth         = 100
      project_name      = "default"
      cloud_firewall_id = "CloudFirewallxxxxxxxx"
    }
    

    Create NatFireWall Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new NatFireWall(name: string, args: NatFireWallArgs, opts?: CustomResourceOptions);
    @overload
    def NatFireWall(resource_name: str,
                    args: NatFireWallArgs,
                    opts: Optional[ResourceOptions] = None)
    
    @overload
    def NatFireWall(resource_name: str,
                    opts: Optional[ResourceOptions] = None,
                    bandwidth: Optional[int] = None,
                    firewall_cidr: Optional[str] = None,
                    nat_firewall_name: Optional[str] = None,
                    nat_gateway_id: Optional[str] = None,
                    cloud_firewall_id: Optional[str] = None,
                    project_name: Optional[str] = None)
    func NewNatFireWall(ctx *Context, name string, args NatFireWallArgs, opts ...ResourceOption) (*NatFireWall, error)
    public NatFireWall(string name, NatFireWallArgs args, CustomResourceOptions? opts = null)
    public NatFireWall(String name, NatFireWallArgs args)
    public NatFireWall(String name, NatFireWallArgs args, CustomResourceOptions options)
    
    type: volcenginecc:fwcenter:NatFireWall
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    
    resource "volcenginecc_fwcenter_nat_fire_wall" "name" {
        # resource properties
    }

    Parameters

    name string
    The unique name of the resource.
    args NatFireWallArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args NatFireWallArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args NatFireWallArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatFireWallArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatFireWallArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var natFireWallResource = new Volcenginecc.Fwcenter.NatFireWall("natFireWallResource", new()
    {
        Bandwidth = 0,
        FirewallCidr = "string",
        NatFirewallName = "string",
        NatGatewayId = "string",
        CloudFirewallId = "string",
        ProjectName = "string",
    });
    
    example, err := fwcenter.NewNatFireWall(ctx, "natFireWallResource", &fwcenter.NatFireWallArgs{
    	Bandwidth:       pulumi.Int(0),
    	FirewallCidr:    pulumi.String("string"),
    	NatFirewallName: pulumi.String("string"),
    	NatGatewayId:    pulumi.String("string"),
    	CloudFirewallId: pulumi.String("string"),
    	ProjectName:     pulumi.String("string"),
    })
    
    resource "volcenginecc_fwcenter_nat_fire_wall" "natFireWallResource" {
      lifecycle {
        create_before_destroy = true
      }
      bandwidth         = 0
      firewall_cidr     = "string"
      nat_firewall_name = "string"
      nat_gateway_id    = "string"
      cloud_firewall_id = "string"
      project_name      = "string"
    }
    
    var natFireWallResource = new NatFireWall("natFireWallResource", NatFireWallArgs.builder()
        .bandwidth(0)
        .firewallCidr("string")
        .natFirewallName("string")
        .natGatewayId("string")
        .cloudFirewallId("string")
        .projectName("string")
        .build());
    
    nat_fire_wall_resource = volcenginecc.fwcenter.NatFireWall("natFireWallResource",
        bandwidth=0,
        firewall_cidr="string",
        nat_firewall_name="string",
        nat_gateway_id="string",
        cloud_firewall_id="string",
        project_name="string")
    
    const natFireWallResource = new volcenginecc.fwcenter.NatFireWall("natFireWallResource", {
        bandwidth: 0,
        firewallCidr: "string",
        natFirewallName: "string",
        natGatewayId: "string",
        cloudFirewallId: "string",
        projectName: "string",
    });
    
    type: volcenginecc:fwcenter:NatFireWall
    properties:
        bandwidth: 0
        cloudFirewallId: string
        firewallCidr: string
        natFirewallName: string
        natGatewayId: string
        projectName: string
    

    NatFireWall 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 NatFireWall resource accepts the following input properties:

    Bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    FirewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    NatFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    NatGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    CloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    ProjectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    Bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    FirewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    NatFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    NatGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    CloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    ProjectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    bandwidth number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    firewall_cidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    nat_firewall_name string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    nat_gateway_id string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    cloud_firewall_id string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    project_name string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    bandwidth Integer
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    firewallCidr String
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    natFirewallName String
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natGatewayId String
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    cloudFirewallId String
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    projectName String
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    bandwidth number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    firewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    natFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    cloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    projectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    firewall_cidr str
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    nat_firewall_name str
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    nat_gateway_id str
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    cloud_firewall_id str
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    project_name str
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    bandwidth Number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    firewallCidr String
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    natFirewallName String
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natGatewayId String
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    cloudFirewallId String
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    projectName String
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the NatFireWall resource produces the following output properties:

    AccountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    CanCreate bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    ErrMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    FirewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    Id string
    The provider-assigned unique ID for this managed resource.
    NatFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    NatFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    NatGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    PeakTrafficWithin7Day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    ProjectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    VpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    VpcId string
    Unique identifier of the associated VPC.
    VpcName string
    Name of the associated VPC.
    ZoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    AccountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    CanCreate bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    ErrMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    FirewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    Id string
    The provider-assigned unique ID for this managed resource.
    NatFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    NatFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    NatGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    PeakTrafficWithin7Day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    ProjectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    VpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    VpcId string
    Unique identifier of the associated VPC.
    VpcName string
    Name of the associated VPC.
    ZoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    account_id string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    can_create bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    err_message string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewall_status string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    id string
    The provider-assigned unique ID for this managed resource.
    nat_firewall_id string
    Unique identifier of the NAT boundary firewall instance.
    nat_firewall_subnet_cidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    nat_gateway_name string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peak_traffic_within7_day number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    project_name_for_nat_gate string
    Project name to which the associated NAT gateway belongs.
    vpc_cidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpc_id string
    Unique identifier of the associated VPC.
    vpc_name string
    Name of the associated VPC.
    zone_id string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId String
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    canCreate Boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    errMessage String
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallStatus String
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    id String
    The provider-assigned unique ID for this managed resource.
    natFirewallId String
    Unique identifier of the NAT boundary firewall instance.
    natFirewallSubnetCidr String
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayName String
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day Integer
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectNameForNatGate String
    Project name to which the associated NAT gateway belongs.
    vpcCidr String
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId String
    Unique identifier of the associated VPC.
    vpcName String
    Name of the associated VPC.
    zoneId String
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    canCreate boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    errMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    id string
    The provider-assigned unique ID for this managed resource.
    natFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    natFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    vpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId string
    Unique identifier of the associated VPC.
    vpcName string
    Name of the associated VPC.
    zoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    account_id str
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    can_create bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    err_message str
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewall_status str
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    id str
    The provider-assigned unique ID for this managed resource.
    nat_firewall_id str
    Unique identifier of the NAT boundary firewall instance.
    nat_firewall_subnet_cidr str
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    nat_gateway_name str
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peak_traffic_within7_day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    project_name_for_nat_gate str
    Project name to which the associated NAT gateway belongs.
    vpc_cidr str
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpc_id str
    Unique identifier of the associated VPC.
    vpc_name str
    Name of the associated VPC.
    zone_id str
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId String
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    canCreate Boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    errMessage String
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallStatus String
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    id String
    The provider-assigned unique ID for this managed resource.
    natFirewallId String
    Unique identifier of the NAT boundary firewall instance.
    natFirewallSubnetCidr String
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayName String
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day Number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectNameForNatGate String
    Project name to which the associated NAT gateway belongs.
    vpcCidr String
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId String
    Unique identifier of the associated VPC.
    vpcName String
    Name of the associated VPC.
    zoneId String
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.

    Look up Existing NatFireWall Resource

    Get an existing NatFireWall resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: NatFireWallState, opts?: CustomResourceOptions): NatFireWall
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            account_id: Optional[str] = None,
            bandwidth: Optional[int] = None,
            can_create: Optional[bool] = None,
            cloud_firewall_id: Optional[str] = None,
            err_message: Optional[str] = None,
            firewall_cidr: Optional[str] = None,
            firewall_status: Optional[str] = None,
            nat_firewall_id: Optional[str] = None,
            nat_firewall_name: Optional[str] = None,
            nat_firewall_subnet_cidr: Optional[str] = None,
            nat_gateway_id: Optional[str] = None,
            nat_gateway_name: Optional[str] = None,
            peak_traffic_within7_day: Optional[int] = None,
            project_name: Optional[str] = None,
            project_name_for_nat_gate: Optional[str] = None,
            vpc_cidr: Optional[str] = None,
            vpc_id: Optional[str] = None,
            vpc_name: Optional[str] = None,
            zone_id: Optional[str] = None) -> NatFireWall
    func GetNatFireWall(ctx *Context, name string, id IDInput, state *NatFireWallState, opts ...ResourceOption) (*NatFireWall, error)
    public static NatFireWall Get(string name, Input<string> id, NatFireWallState? state, CustomResourceOptions? opts = null)
    public static NatFireWall get(String name, Output<String> id, NatFireWallState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:fwcenter:NatFireWall    get:      id: ${id}
    import {
      to = volcenginecc_fwcenter_nat_fire_wall.example
      id = "${id}"
    }
    
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AccountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    Bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    CanCreate bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    CloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    ErrMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    FirewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    FirewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    NatFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    NatFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    NatFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    NatGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    NatGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    PeakTrafficWithin7Day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    ProjectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    ProjectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    VpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    VpcId string
    Unique identifier of the associated VPC.
    VpcName string
    Name of the associated VPC.
    ZoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    AccountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    Bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    CanCreate bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    CloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    ErrMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    FirewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    FirewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    NatFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    NatFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    NatFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    NatGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    NatGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    PeakTrafficWithin7Day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    ProjectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    ProjectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    VpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    VpcId string
    Unique identifier of the associated VPC.
    VpcName string
    Name of the associated VPC.
    ZoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    account_id string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    bandwidth number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    can_create bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    cloud_firewall_id string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    err_message string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewall_cidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    firewall_status string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    nat_firewall_id string
    Unique identifier of the NAT boundary firewall instance.
    nat_firewall_name string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    nat_firewall_subnet_cidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    nat_gateway_id string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    nat_gateway_name string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peak_traffic_within7_day number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    project_name string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    project_name_for_nat_gate string
    Project name to which the associated NAT gateway belongs.
    vpc_cidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpc_id string
    Unique identifier of the associated VPC.
    vpc_name string
    Name of the associated VPC.
    zone_id string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId String
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    bandwidth Integer
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    canCreate Boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    cloudFirewallId String
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    errMessage String
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallCidr String
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    firewallStatus String
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    natFirewallId String
    Unique identifier of the NAT boundary firewall instance.
    natFirewallName String
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natFirewallSubnetCidr String
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayId String
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    natGatewayName String
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day Integer
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectName String
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    projectNameForNatGate String
    Project name to which the associated NAT gateway belongs.
    vpcCidr String
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId String
    Unique identifier of the associated VPC.
    vpcName String
    Name of the associated VPC.
    zoneId String
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId string
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    bandwidth number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    canCreate boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    cloudFirewallId string
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    errMessage string
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallCidr string
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    firewallStatus string
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    natFirewallId string
    Unique identifier of the NAT boundary firewall instance.
    natFirewallName string
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natFirewallSubnetCidr string
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayId string
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    natGatewayName string
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectName string
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    projectNameForNatGate string
    Project name to which the associated NAT gateway belongs.
    vpcCidr string
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId string
    Unique identifier of the associated VPC.
    vpcName string
    Name of the associated VPC.
    zoneId string
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    account_id str
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    bandwidth int
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    can_create bool
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    cloud_firewall_id str
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    err_message str
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewall_cidr str
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    firewall_status str
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    nat_firewall_id str
    Unique identifier of the NAT boundary firewall instance.
    nat_firewall_name str
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    nat_firewall_subnet_cidr str
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    nat_gateway_id str
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    nat_gateway_name str
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peak_traffic_within7_day int
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    project_name str
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    project_name_for_nat_gate str
    Project name to which the associated NAT gateway belongs.
    vpc_cidr str
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpc_id str
    Unique identifier of the associated VPC.
    vpc_name str
    Name of the associated VPC.
    zone_id str
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.
    accountId String
    Account ID for creating the NAT firewall, used to identify the account to which the NAT boundary firewall instance belongs.
    bandwidth Number
    Authorized traffic bandwidth of the NAT boundary firewall instance, measured in Mbps, indicating the maximum network bandwidth allowed for the firewall instance. The minimum value is 10.
    canCreate Boolean
    Indicates whether creating a NAT boundary firewall is currently supported. true means supported, false means not supported.
    cloudFirewallId String
    Cloud firewall instance ID, used to identify and manage the cloud firewall instance.
    errMessage String
    Error message returned when an error occurs during the creation or query of a NAT boundary firewall instance, used to describe the specific cause of the error.
    firewallCidr String
    Subnet CIDR of the NAT boundary firewall, used to specify the network range protected by the firewall, expressed in CIDR format.
    firewallStatus String
    Status of the NAT boundary firewall instance. creating: being created; deleting: being deleted; opened: created; closed: not created; error: error; updating: being upgraded.
    natFirewallId String
    Unique identifier of the NAT boundary firewall instance.
    natFirewallName String
    Name of the NAT boundary firewall instance, used to identify and manage the firewall instance.
    natFirewallSubnetCidr String
    Subnet CIDR of the NAT boundary firewall instance, used to identify the subnet IP address range protected by the firewall instance.
    natGatewayId String
    NAT gateway instance ID, used to identify and manage the NAT gateway instance. You must specify the associated NAT gateway when creating a NAT firewall.
    natGatewayName String
    Name of the NAT gateway, used to identify the associated NAT gateway.
    peakTrafficWithin7Day Number
    Peak traffic of the NAT boundary firewall instance in the past 7 days, measured in bps, used to monitor the highest network traffic usage.
    projectName String
    Project name, used to identify and manage the project to which the resource belongs. The default value is default.
    projectNameForNatGate String
    Project name to which the associated NAT gateway belongs.
    vpcCidr String
    Subnet CIDR of the associated VPC, used to identify the IP address range of the VPC.
    vpcId String
    Unique identifier of the associated VPC.
    vpcName String
    Name of the associated VPC.
    zoneId String
    Availability zone where the NAT boundary firewall instance is located, used to identify the specific physical area where the instance is deployed.

    Import

    $ pulumi import volcenginecc:fwcenter/natFireWall:NatFireWall example "nat_firewall_id"
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    volcenginecc volcengine/pulumi-volcenginecc
    License
    MPL-2.0
    Notes
    This Pulumi package is based on the volcenginecc Terraform Provider.
    volcenginecc logo
    Viewing docs for volcenginecc v0.0.60
    published on Thursday, Sep 3, 2026 by Volcengine

      Try Pulumi Cloud free.
      Your team will thank you.

      Start free trial