1. Packages
  2. Volcenginecc Provider
  3. API Docs
  4. natgateway
  5. Ngw
volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine
volcenginecc logo
volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine

    NAT网关为私有网络内的云服务器提供网络地址转换服务。

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as volcenginecc from "@volcengine/pulumi-volcenginecc";
    
    const natGatewayNGWDemo = new volcenginecc.natgateway.Ngw("NatGatewayNGWDemo", {
        spec: "Small",
        vpcId: "vpc-2f8kicbjkot8g4f4pzyyxxxxx",
        subnetId: "subnet-3hicda1321wqo3nkipk4xxxxx",
        natGatewayName: "NatGatewayNGWDemo",
        billingType: 2,
        projectName: "default",
        networkType: "internet",
        description: "NatGatewayNGWDemo",
        tags: [{
            key: "env",
            value: "test",
        }],
    });
    
    import pulumi
    import pulumi_volcenginecc as volcenginecc
    
    nat_gateway_ngw_demo = volcenginecc.natgateway.Ngw("NatGatewayNGWDemo",
        spec="Small",
        vpc_id="vpc-2f8kicbjkot8g4f4pzyyxxxxx",
        subnet_id="subnet-3hicda1321wqo3nkipk4xxxxx",
        nat_gateway_name="NatGatewayNGWDemo",
        billing_type=2,
        project_name="default",
        network_type="internet",
        description="NatGatewayNGWDemo",
        tags=[{
            "key": "env",
            "value": "test",
        }])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/volcengine/pulumi-volcenginecc/sdk/go/volcenginecc/natgateway"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := natgateway.NewNgw(ctx, "NatGatewayNGWDemo", &natgateway.NgwArgs{
    			Spec:           pulumi.String("Small"),
    			VpcId:          pulumi.String("vpc-2f8kicbjkot8g4f4pzyyxxxxx"),
    			SubnetId:       pulumi.String("subnet-3hicda1321wqo3nkipk4xxxxx"),
    			NatGatewayName: pulumi.String("NatGatewayNGWDemo"),
    			BillingType:    pulumi.Int(2),
    			ProjectName:    pulumi.String("default"),
    			NetworkType:    pulumi.String("internet"),
    			Description:    pulumi.String("NatGatewayNGWDemo"),
    			Tags: natgateway.NgwTagArray{
    				&natgateway.NgwTagArgs{
    					Key:   pulumi.String("env"),
    					Value: pulumi.String("test"),
    				},
    			},
    		})
    		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 natGatewayNGWDemo = new Volcenginecc.Natgateway.Ngw("NatGatewayNGWDemo", new()
        {
            Spec = "Small",
            VpcId = "vpc-2f8kicbjkot8g4f4pzyyxxxxx",
            SubnetId = "subnet-3hicda1321wqo3nkipk4xxxxx",
            NatGatewayName = "NatGatewayNGWDemo",
            BillingType = 2,
            ProjectName = "default",
            NetworkType = "internet",
            Description = "NatGatewayNGWDemo",
            Tags = new[]
            {
                new Volcenginecc.Natgateway.Inputs.NgwTagArgs
                {
                    Key = "env",
                    Value = "test",
                },
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.volcengine.volcenginecc.natgateway.Ngw;
    import com.volcengine.volcenginecc.natgateway.NgwArgs;
    import com.pulumi.volcenginecc.natgateway.inputs.NgwTagArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 natGatewayNGWDemo = new Ngw("natGatewayNGWDemo", NgwArgs.builder()
                .spec("Small")
                .vpcId("vpc-2f8kicbjkot8g4f4pzyyxxxxx")
                .subnetId("subnet-3hicda1321wqo3nkipk4xxxxx")
                .natGatewayName("NatGatewayNGWDemo")
                .billingType(2)
                .projectName("default")
                .networkType("internet")
                .description("NatGatewayNGWDemo")
                .tags(NgwTagArgs.builder()
                    .key("env")
                    .value("test")
                    .build())
                .build());
    
        }
    }
    
    resources:
      natGatewayNGWDemo:
        type: volcenginecc:natgateway:Ngw
        name: NatGatewayNGWDemo
        properties:
          spec: Small
          vpcId: vpc-2f8kicbjkot8g4f4pzyyxxxxx
          subnetId: subnet-3hicda1321wqo3nkipk4xxxxx
          natGatewayName: NatGatewayNGWDemo
          billingType: 2
          projectName: default
          networkType: internet
          description: NatGatewayNGWDemo
          tags:
            - key: env
              value: test
    

    Create Ngw Resource

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

    Constructor syntax

    new Ngw(name: string, args: NgwArgs, opts?: CustomResourceOptions);
    @overload
    def Ngw(resource_name: str,
            args: NgwArgs,
            opts: Optional[ResourceOptions] = None)
    
    @overload
    def Ngw(resource_name: str,
            opts: Optional[ResourceOptions] = None,
            vpc_id: Optional[str] = None,
            project_name: Optional[str] = None,
            nat_gateway_name: Optional[str] = None,
            network_type: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            billing_type: Optional[int] = None,
            smart_schedule_enabled: Optional[bool] = None,
            smart_schedule_rule: Optional[str] = None,
            spec: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Sequence[NgwTagArgs]] = None,
            description: Optional[str] = None)
    func NewNgw(ctx *Context, name string, args NgwArgs, opts ...ResourceOption) (*Ngw, error)
    public Ngw(string name, NgwArgs args, CustomResourceOptions? opts = null)
    public Ngw(String name, NgwArgs args)
    public Ngw(String name, NgwArgs args, CustomResourceOptions options)
    
    type: volcenginecc:natgateway:Ngw
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args NgwArgs
    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 NgwArgs
    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 NgwArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NgwArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NgwArgs
    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 ngwResource = new Volcenginecc.Natgateway.Ngw("ngwResource", new()
    {
        VpcId = "string",
        ProjectName = "string",
        NatGatewayName = "string",
        NetworkType = "string",
        Period = 0,
        PeriodUnit = "string",
        BillingType = 0,
        SmartScheduleEnabled = false,
        SmartScheduleRule = "string",
        Spec = "string",
        SubnetId = "string",
        Tags = new[]
        {
            new Volcenginecc.Natgateway.Inputs.NgwTagArgs
            {
                Key = "string",
                Value = "string",
            },
        },
        Description = "string",
    });
    
    example, err := natgateway.NewNgw(ctx, "ngwResource", &natgateway.NgwArgs{
    	VpcId:                pulumi.String("string"),
    	ProjectName:          pulumi.String("string"),
    	NatGatewayName:       pulumi.String("string"),
    	NetworkType:          pulumi.String("string"),
    	Period:               pulumi.Int(0),
    	PeriodUnit:           pulumi.String("string"),
    	BillingType:          pulumi.Int(0),
    	SmartScheduleEnabled: pulumi.Bool(false),
    	SmartScheduleRule:    pulumi.String("string"),
    	Spec:                 pulumi.String("string"),
    	SubnetId:             pulumi.String("string"),
    	Tags: natgateway.NgwTagArray{
    		&natgateway.NgwTagArgs{
    			Key:   pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	Description: pulumi.String("string"),
    })
    
    var ngwResource = new Ngw("ngwResource", NgwArgs.builder()
        .vpcId("string")
        .projectName("string")
        .natGatewayName("string")
        .networkType("string")
        .period(0)
        .periodUnit("string")
        .billingType(0)
        .smartScheduleEnabled(false)
        .smartScheduleRule("string")
        .spec("string")
        .subnetId("string")
        .tags(NgwTagArgs.builder()
            .key("string")
            .value("string")
            .build())
        .description("string")
        .build());
    
    ngw_resource = volcenginecc.natgateway.Ngw("ngwResource",
        vpc_id="string",
        project_name="string",
        nat_gateway_name="string",
        network_type="string",
        period=0,
        period_unit="string",
        billing_type=0,
        smart_schedule_enabled=False,
        smart_schedule_rule="string",
        spec="string",
        subnet_id="string",
        tags=[{
            "key": "string",
            "value": "string",
        }],
        description="string")
    
    const ngwResource = new volcenginecc.natgateway.Ngw("ngwResource", {
        vpcId: "string",
        projectName: "string",
        natGatewayName: "string",
        networkType: "string",
        period: 0,
        periodUnit: "string",
        billingType: 0,
        smartScheduleEnabled: false,
        smartScheduleRule: "string",
        spec: "string",
        subnetId: "string",
        tags: [{
            key: "string",
            value: "string",
        }],
        description: "string",
    });
    
    type: volcenginecc:natgateway:Ngw
    properties:
        billingType: 0
        description: string
        natGatewayName: string
        networkType: string
        period: 0
        periodUnit: string
        projectName: string
        smartScheduleEnabled: false
        smartScheduleRule: string
        spec: string
        subnetId: string
        tags:
            - key: string
              value: string
        vpcId: string
    

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

    VpcId string
    NAT网关所在私有网络的ID。
    BillingType int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    Description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    NatGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    NetworkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    Period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    PeriodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    ProjectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    SmartScheduleEnabled bool
    是否开启智能调度。
    SmartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    Spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    SubnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    Tags List<Volcengine.NgwTag>
    VpcId string
    NAT网关所在私有网络的ID。
    BillingType int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    Description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    NatGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    NetworkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    Period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    PeriodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    ProjectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    SmartScheduleEnabled bool
    是否开启智能调度。
    SmartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    Spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    SubnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    Tags []NgwTagArgs
    vpcId String
    NAT网关所在私有网络的ID。
    billingType Integer
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    description String
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    natGatewayName String
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    networkType String
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    period Integer
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit String
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName String
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled Boolean
    是否开启智能调度。
    smartScheduleRule String
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    spec String
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    subnetId String
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags List<NgwTag>
    vpcId string
    NAT网关所在私有网络的ID。
    billingType number
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    natGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    networkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    period number
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled boolean
    是否开启智能调度。
    smartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    subnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags NgwTag[]
    vpc_id str
    NAT网关所在私有网络的ID。
    billing_type int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    description str
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    nat_gateway_name str
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    network_type str
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    period_unit str
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    project_name str
    NAT网关所属项目的名称。不填默认加入default项目。
    smart_schedule_enabled bool
    是否开启智能调度。
    smart_schedule_rule str
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    spec str
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    subnet_id str
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags Sequence[NgwTagArgs]
    vpcId String
    NAT网关所在私有网络的ID。
    billingType Number
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    description String
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    natGatewayName String
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    networkType String
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    period Number
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit String
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName String
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled Boolean
    是否开启智能调度。
    smartScheduleRule String
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    spec String
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    subnetId String
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags List<Property Map>

    Outputs

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

    BusinessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    CreatedTime string
    创建时间
    DeletedTime string
    删除时间
    DirectMode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    DnatEntryIds List<string>
    DNAT规则ID列表。
    EipAddresses List<Volcengine.NgwEipAddress>
    ExpiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    NatGatewayId string
    NAT网关ID。
    NatIpAddresses List<Volcengine.NgwNatIpAddress>
    NetworkInterfaceId string
    NAT网关占用的网卡ID。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    SnatEntryIds List<string>
    SNAT规则ID列表。
    Status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    UpdatedTime string
    NAT网关的最后操作时间。
    ZoneId string
    NAT网关所属主可用区的ID。
    BusinessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    CreatedTime string
    创建时间
    DeletedTime string
    删除时间
    DirectMode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    DnatEntryIds []string
    DNAT规则ID列表。
    EipAddresses []NgwEipAddress
    ExpiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    NatGatewayId string
    NAT网关ID。
    NatIpAddresses []NgwNatIpAddress
    NetworkInterfaceId string
    NAT网关占用的网卡ID。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    SnatEntryIds []string
    SNAT规则ID列表。
    Status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    UpdatedTime string
    NAT网关的最后操作时间。
    ZoneId string
    NAT网关所属主可用区的ID。
    businessStatus String
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime String
    创建时间
    deletedTime String
    删除时间
    directMode Boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds List<String>
    DNAT规则ID列表。
    eipAddresses List<NgwEipAddress>
    expiredTime String
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId String
    NAT网关ID。
    natIpAddresses List<NgwNatIpAddress>
    networkInterfaceId String
    NAT网关占用的网卡ID。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    snatEntryIds List<String>
    SNAT规则ID列表。
    status String
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    updatedTime String
    NAT网关的最后操作时间。
    zoneId String
    NAT网关所属主可用区的ID。
    businessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime string
    创建时间
    deletedTime string
    删除时间
    directMode boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds string[]
    DNAT规则ID列表。
    eipAddresses NgwEipAddress[]
    expiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    id string
    The provider-assigned unique ID for this managed resource.
    lockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId string
    NAT网关ID。
    natIpAddresses NgwNatIpAddress[]
    networkInterfaceId string
    NAT网关占用的网卡ID。
    overdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    snatEntryIds string[]
    SNAT规则ID列表。
    status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    updatedTime string
    NAT网关的最后操作时间。
    zoneId string
    NAT网关所属主可用区的ID。
    business_status str
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    created_time str
    创建时间
    deleted_time str
    删除时间
    direct_mode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnat_entry_ids Sequence[str]
    DNAT规则ID列表。
    eip_addresses Sequence[NgwEipAddress]
    expired_time str
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    id str
    The provider-assigned unique ID for this managed resource.
    lock_reason str
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    nat_gateway_id str
    NAT网关ID。
    nat_ip_addresses Sequence[NgwNatIpAddress]
    network_interface_id str
    NAT网关占用的网卡ID。
    overdue_time str
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    snat_entry_ids Sequence[str]
    SNAT规则ID列表。
    status str
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    updated_time str
    NAT网关的最后操作时间。
    zone_id str
    NAT网关所属主可用区的ID。
    businessStatus String
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime String
    创建时间
    deletedTime String
    删除时间
    directMode Boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds List<String>
    DNAT规则ID列表。
    eipAddresses List<Property Map>
    expiredTime String
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId String
    NAT网关ID。
    natIpAddresses List<Property Map>
    networkInterfaceId String
    NAT网关占用的网卡ID。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    snatEntryIds List<String>
    SNAT规则ID列表。
    status String
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    updatedTime String
    NAT网关的最后操作时间。
    zoneId String
    NAT网关所属主可用区的ID。

    Look up Existing Ngw Resource

    Get an existing Ngw 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?: NgwState, opts?: CustomResourceOptions): Ngw
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            billing_type: Optional[int] = None,
            business_status: Optional[str] = None,
            created_time: Optional[str] = None,
            deleted_time: Optional[str] = None,
            description: Optional[str] = None,
            direct_mode: Optional[bool] = None,
            dnat_entry_ids: Optional[Sequence[str]] = None,
            eip_addresses: Optional[Sequence[NgwEipAddressArgs]] = None,
            expired_time: Optional[str] = None,
            lock_reason: Optional[str] = None,
            nat_gateway_id: Optional[str] = None,
            nat_gateway_name: Optional[str] = None,
            nat_ip_addresses: Optional[Sequence[NgwNatIpAddressArgs]] = None,
            network_interface_id: Optional[str] = None,
            network_type: Optional[str] = None,
            overdue_time: Optional[str] = None,
            period: Optional[int] = None,
            period_unit: Optional[str] = None,
            project_name: Optional[str] = None,
            smart_schedule_enabled: Optional[bool] = None,
            smart_schedule_rule: Optional[str] = None,
            snat_entry_ids: Optional[Sequence[str]] = None,
            spec: Optional[str] = None,
            status: Optional[str] = None,
            subnet_id: Optional[str] = None,
            tags: Optional[Sequence[NgwTagArgs]] = None,
            updated_time: Optional[str] = None,
            vpc_id: Optional[str] = None,
            zone_id: Optional[str] = None) -> Ngw
    func GetNgw(ctx *Context, name string, id IDInput, state *NgwState, opts ...ResourceOption) (*Ngw, error)
    public static Ngw Get(string name, Input<string> id, NgwState? state, CustomResourceOptions? opts = null)
    public static Ngw get(String name, Output<String> id, NgwState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:natgateway:Ngw    get:      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:
    BillingType int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    BusinessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    CreatedTime string
    创建时间
    DeletedTime string
    删除时间
    Description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    DirectMode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    DnatEntryIds List<string>
    DNAT规则ID列表。
    EipAddresses List<Volcengine.NgwEipAddress>
    ExpiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    LockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    NatGatewayId string
    NAT网关ID。
    NatGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    NatIpAddresses List<Volcengine.NgwNatIpAddress>
    NetworkInterfaceId string
    NAT网关占用的网卡ID。
    NetworkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    Period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    PeriodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    ProjectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    SmartScheduleEnabled bool
    是否开启智能调度。
    SmartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    SnatEntryIds List<string>
    SNAT规则ID列表。
    Spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    Status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    SubnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    Tags List<Volcengine.NgwTag>
    UpdatedTime string
    NAT网关的最后操作时间。
    VpcId string
    NAT网关所在私有网络的ID。
    ZoneId string
    NAT网关所属主可用区的ID。
    BillingType int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    BusinessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    CreatedTime string
    创建时间
    DeletedTime string
    删除时间
    Description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    DirectMode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    DnatEntryIds []string
    DNAT规则ID列表。
    EipAddresses []NgwEipAddressArgs
    ExpiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    LockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    NatGatewayId string
    NAT网关ID。
    NatGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    NatIpAddresses []NgwNatIpAddressArgs
    NetworkInterfaceId string
    NAT网关占用的网卡ID。
    NetworkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    OverdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    Period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    PeriodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    ProjectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    SmartScheduleEnabled bool
    是否开启智能调度。
    SmartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    SnatEntryIds []string
    SNAT规则ID列表。
    Spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    Status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    SubnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    Tags []NgwTagArgs
    UpdatedTime string
    NAT网关的最后操作时间。
    VpcId string
    NAT网关所在私有网络的ID。
    ZoneId string
    NAT网关所属主可用区的ID。
    billingType Integer
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    businessStatus String
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime String
    创建时间
    deletedTime String
    删除时间
    description String
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    directMode Boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds List<String>
    DNAT规则ID列表。
    eipAddresses List<NgwEipAddress>
    expiredTime String
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    lockReason String
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId String
    NAT网关ID。
    natGatewayName String
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    natIpAddresses List<NgwNatIpAddress>
    networkInterfaceId String
    NAT网关占用的网卡ID。
    networkType String
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    period Integer
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit String
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName String
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled Boolean
    是否开启智能调度。
    smartScheduleRule String
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    snatEntryIds List<String>
    SNAT规则ID列表。
    spec String
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    status String
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    subnetId String
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags List<NgwTag>
    updatedTime String
    NAT网关的最后操作时间。
    vpcId String
    NAT网关所在私有网络的ID。
    zoneId String
    NAT网关所属主可用区的ID。
    billingType number
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    businessStatus string
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime string
    创建时间
    deletedTime string
    删除时间
    description string
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    directMode boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds string[]
    DNAT规则ID列表。
    eipAddresses NgwEipAddress[]
    expiredTime string
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    lockReason string
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId string
    NAT网关ID。
    natGatewayName string
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    natIpAddresses NgwNatIpAddress[]
    networkInterfaceId string
    NAT网关占用的网卡ID。
    networkType string
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    overdueTime string
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    period number
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit string
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName string
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled boolean
    是否开启智能调度。
    smartScheduleRule string
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    snatEntryIds string[]
    SNAT规则ID列表。
    spec string
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    status string
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    subnetId string
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags NgwTag[]
    updatedTime string
    NAT网关的最后操作时间。
    vpcId string
    NAT网关所在私有网络的ID。
    zoneId string
    NAT网关所属主可用区的ID。
    billing_type int
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    business_status str
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    created_time str
    创建时间
    deleted_time str
    删除时间
    description str
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    direct_mode bool
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnat_entry_ids Sequence[str]
    DNAT规则ID列表。
    eip_addresses Sequence[NgwEipAddressArgs]
    expired_time str
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    lock_reason str
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    nat_gateway_id str
    NAT网关ID。
    nat_gateway_name str
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    nat_ip_addresses Sequence[NgwNatIpAddressArgs]
    network_interface_id str
    NAT网关占用的网卡ID。
    network_type str
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    overdue_time str
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    period int
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    period_unit str
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    project_name str
    NAT网关所属项目的名称。不填默认加入default项目。
    smart_schedule_enabled bool
    是否开启智能调度。
    smart_schedule_rule str
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    snat_entry_ids Sequence[str]
    SNAT规则ID列表。
    spec str
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    status str
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    subnet_id str
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags Sequence[NgwTagArgs]
    updated_time str
    NAT网关的最后操作时间。
    vpc_id str
    NAT网关所在私有网络的ID。
    zone_id str
    NAT网关所属主可用区的ID。
    billingType Number
    NAT网关的计费方式。取值如下:1 :包年包月。2(默认值):按量计费-按规格计费。3:按量计费-按使用量计费。当NetworkType传入intranet时,本参数仅支持且必须传入3。
    businessStatus String
    NAT网关是否被锁定。空值:正常未被锁定。Normal:正常未被锁定。FinancialLocked:因欠费被锁定。
    createdTime String
    创建时间
    deletedTime String
    删除时间
    description String
    NAT网关的描述。需要以字母、中文或数字开头。可包含英文逗号(,)、点号(.)、下划线(_)、空格( )、等号(=)、短横线(-)、中文逗号(,)、中文句号(。)。长度限制为1 ~ 255个字符。不填默认空字符串。
    directMode Boolean
    标识该nat是直通还是非直通。 - true(默认):EIP直通nat网关。 - false:非EIP直通nat网关。
    dnatEntryIds List<String>
    DNAT规则ID列表。
    eipAddresses List<Property Map>
    expiredTime String
    包年包月NAT网关到期时间。仅包年包月计费类型的NAT网关会返回此参数。
    lockReason String
    NAT被锁定的原因。financial:因欠费被锁定。security:因安全原因被锁定。
    natGatewayId String
    NAT网关ID。
    natGatewayName String
    NAT网关的名称。需要以字母、中文或数字开头,可包含点号(.)、下划线(_)和短划线(-)。长度限制为1 ~ 128个字符。不填默认是NAT网关实例的ID。
    natIpAddresses List<Property Map>
    networkInterfaceId String
    NAT网关占用的网卡ID。
    networkType String
    NAT网关类型。internet:公网NAT网关。intranet:私网NAT网关。
    overdueTime String
    资源冻结时间。仅当资源因为欠费冻结,此参数才会有返回值。
    period Number
    购买包年包月NAT网关的时长,默认1。当PeriodUnit传入Month,Period取值范围:1 ~ 9、12、24、36。当PeriodUnit传入Year,Period取值范围:1 ~ 3。
    periodUnit String
    购买包年包月NAT网关时长的单位,默认Month。Month :月。Year :年。
    projectName String
    NAT网关所属项目的名称。不填默认加入default项目。
    smartScheduleEnabled Boolean
    是否开启智能调度。
    smartScheduleRule String
    智能调度策略规则。ChinaMobile:中国移动。ChinaUnicom:中国联通。ChinaTelecom:中国电信。BGP:BGP多线。
    snatEntryIds List<String>
    SNAT规则ID列表。
    spec String
    NAT网关的规格。Small(默认):小型。Medium:中型。Large:大型。ExtraLarge1:超大型-1。ExtraLarge2:超大型-2。
    status String
    NAT网关的状态。Available:可用。Creating:创建中。Pending:操作中。Deleting:删除中。
    subnetId String
    NAT网关所在子网的ID。传入的子网,必须是VpcId传入的私有网络的子网。子网内至少有一个可用的私网IP。系统自动生成的NAT网关网卡将占用该子网一个私网IP。子网所在的可用区需要已部署NAT网关资源。子网所在可用区将作为NAT网关的主可用区,并自动关联备可用区。当主可用区发生故障时,NAT网关自动切换到备可用区。
    tags List<Property Map>
    updatedTime String
    NAT网关的最后操作时间。
    vpcId String
    NAT网关所在私有网络的ID。
    zoneId String
    NAT网关所属主可用区的ID。

    Supporting Types

    NgwEipAddress, NgwEipAddressArgs

    AllocationId string
    公网IP的ID。
    EipAddress string
    公网IP的地址。
    UsingStatus string
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。
    AllocationId string
    公网IP的ID。
    EipAddress string
    公网IP的地址。
    UsingStatus string
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。
    allocationId String
    公网IP的ID。
    eipAddress String
    公网IP的地址。
    usingStatus String
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。
    allocationId string
    公网IP的ID。
    eipAddress string
    公网IP的地址。
    usingStatus string
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。
    allocation_id str
    公网IP的ID。
    eip_address str
    公网IP的地址。
    using_status str
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。
    allocationId String
    公网IP的ID。
    eipAddress String
    公网IP的地址。
    usingStatus String
    公网IP的使用状态。Idle:未使用。UsedBySnat:被SNAT规则使用。UsedByDnat:被DNAT规则使用。UsedByNat:被SNAT/DNAT规则同时使用。

    NgwNatIpAddress, NgwNatIpAddressArgs

    NatIpAddress string
    中转Ip地址。
    NatIpId string
    中转Ip id。
    NatIpAddress string
    中转Ip地址。
    NatIpId string
    中转Ip id。
    natIpAddress String
    中转Ip地址。
    natIpId String
    中转Ip id。
    natIpAddress string
    中转Ip地址。
    natIpId string
    中转Ip id。
    nat_ip_address str
    中转Ip地址。
    nat_ip_id str
    中转Ip id。
    natIpAddress String
    中转Ip地址。
    natIpId String
    中转Ip id。

    NgwTag, NgwTagArgs

    Key string
    用户标签的标签键。
    Value string
    用户标签的标签值。
    Key string
    用户标签的标签键。
    Value string
    用户标签的标签值。
    key String
    用户标签的标签键。
    value String
    用户标签的标签值。
    key string
    用户标签的标签键。
    value string
    用户标签的标签值。
    key str
    用户标签的标签键。
    value str
    用户标签的标签值。
    key String
    用户标签的标签键。
    value String
    用户标签的标签值。

    Import

    $ pulumi import volcenginecc:natgateway/ngw:Ngw example "nat_gateway_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
    volcenginecc v0.0.11 published on Thursday, Dec 4, 2025 by Volcengine
      Meet Neo: Your AI Platform Teammate