1. Packages
  2. Packages
  3. Volcenginecc Provider
  4. API Docs
  5. natgateway
  6. Ngw
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

volcenginecc.natgateway.Ngw

volcenginecc logo
Viewing docs for volcenginecc v0.0.32
published on Thursday, Apr 23, 2026 by Volcengine
Schema (JSON)
volcengine/pulumi-volcenginecc

    NAT Gateway provides network address translation services for cloud servers within the private network

    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.

    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
    ID of the private network where the NAT Gateway is located
    BillingType int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags List<Volcengine.NgwTag>
    VpcId string
    ID of the private network where the NAT Gateway is located
    BillingType int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags []NgwTagArgs
    vpcId String
    ID of the private network where the NAT Gateway is located
    billingType Integer
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    period Integer
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags List<NgwTag>
    vpcId string
    ID of the private network where the NAT Gateway is located
    billingType number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    natGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    networkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    period number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled boolean
    Whether to enable intelligent scheduling
    smartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    subnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags NgwTag[]
    vpc_id str
    ID of the private network where the NAT Gateway is located
    billing_type int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    description str
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    nat_gateway_name str
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    network_type str
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    period_unit str
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    project_name str
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smart_schedule_enabled bool
    Whether to enable intelligent scheduling
    smart_schedule_rule str
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    spec str
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    subnet_id str
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags Sequence[NgwTagArgs]
    vpcId String
    ID of the private network where the NAT Gateway is located
    billingType Number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    period Number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    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
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds List<string>
    DNAT rule ID list.
    EipAddresses List<Volcengine.NgwEipAddress>
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatIpAddresses List<Volcengine.NgwNatIpAddress>
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    SnatEntryIds List<string>
    SNAT rule ID list
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    UpdatedTime string
    Last operation time of the NAT Gateway
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    BusinessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds []string
    DNAT rule ID list.
    EipAddresses []NgwEipAddress
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    Id string
    The provider-assigned unique ID for this managed resource.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatIpAddresses []NgwNatIpAddress
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    SnatEntryIds []string
    SNAT rule ID list
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    UpdatedTime string
    Last operation time of the NAT Gateway
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<NgwEipAddress>
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natIpAddresses List<NgwNatIpAddress>
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    snatEntryIds List<String>
    SNAT rule ID list
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    updatedTime String
    Last operation time of the NAT Gateway
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to
    businessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime string
    Creation time
    deletedTime string
    Deletion time
    directMode boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds string[]
    DNAT rule ID list.
    eipAddresses NgwEipAddress[]
    expiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id string
    The provider-assigned unique ID for this managed resource.
    lockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId string
    NAT gateway ID.
    natIpAddresses NgwNatIpAddress[]
    networkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    snatEntryIds string[]
    SNAT rule ID list
    status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    updatedTime string
    Last operation time of the NAT Gateway
    zoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    business_status str
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    created_time str
    Creation time
    deleted_time str
    Deletion time
    direct_mode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnat_entry_ids Sequence[str]
    DNAT rule ID list.
    eip_addresses Sequence[NgwEipAddress]
    expired_time str
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id str
    The provider-assigned unique ID for this managed resource.
    lock_reason str
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    nat_gateway_id str
    NAT gateway ID.
    nat_ip_addresses Sequence[NgwNatIpAddress]
    network_interface_id str
    Network interface ID occupied by the NAT gateway.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    snat_entry_ids Sequence[str]
    SNAT rule ID list
    status str
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    updated_time str
    Last operation time of the NAT Gateway
    zone_id str
    ID of the primary availability zone the NAT Gateway belongs to
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<Property Map>
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    id String
    The provider-assigned unique ID for this managed resource.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natIpAddresses List<Property Map>
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    snatEntryIds List<String>
    SNAT rule ID list
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    updatedTime String
    Last operation time of the NAT Gateway
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to

    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 Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    BusinessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds List<string>
    DNAT rule ID list.
    EipAddresses List<Volcengine.NgwEipAddress>
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NatIpAddresses List<Volcengine.NgwNatIpAddress>
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    SnatEntryIds List<string>
    SNAT rule ID list
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags List<Volcengine.NgwTag>
    UpdatedTime string
    Last operation time of the NAT Gateway
    VpcId string
    ID of the private network where the NAT Gateway is located
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    BillingType int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    BusinessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    CreatedTime string
    Creation time
    DeletedTime string
    Deletion time
    Description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    DirectMode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    DnatEntryIds []string
    DNAT rule ID list.
    EipAddresses []NgwEipAddressArgs
    ExpiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    LockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    NatGatewayId string
    NAT gateway ID.
    NatGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    NatIpAddresses []NgwNatIpAddressArgs
    NetworkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    NetworkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    OverdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    Period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    PeriodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    ProjectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    SmartScheduleEnabled bool
    Whether to enable intelligent scheduling
    SmartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    SnatEntryIds []string
    SNAT rule ID list
    Spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    Status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    SubnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    Tags []NgwTagArgs
    UpdatedTime string
    Last operation time of the NAT Gateway
    VpcId string
    ID of the private network where the NAT Gateway is located
    ZoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    billingType Integer
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<NgwEipAddress>
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses List<NgwNatIpAddress>
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period Integer
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds List<String>
    SNAT rule ID list
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags List<NgwTag>
    updatedTime String
    Last operation time of the NAT Gateway
    vpcId String
    ID of the private network where the NAT Gateway is located
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to
    billingType number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus string
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime string
    Creation time
    deletedTime string
    Deletion time
    description string
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds string[]
    DNAT rule ID list.
    eipAddresses NgwEipAddress[]
    expiredTime string
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    lockReason string
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId string
    NAT gateway ID.
    natGatewayName string
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses NgwNatIpAddress[]
    networkInterfaceId string
    Network interface ID occupied by the NAT gateway.
    networkType string
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime string
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit string
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName string
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled boolean
    Whether to enable intelligent scheduling
    smartScheduleRule string
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds string[]
    SNAT rule ID list
    spec string
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status string
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId string
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags NgwTag[]
    updatedTime string
    Last operation time of the NAT Gateway
    vpcId string
    ID of the private network where the NAT Gateway is located
    zoneId string
    ID of the primary availability zone the NAT Gateway belongs to
    billing_type int
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    business_status str
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    created_time str
    Creation time
    deleted_time str
    Deletion time
    description str
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    direct_mode bool
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnat_entry_ids Sequence[str]
    DNAT rule ID list.
    eip_addresses Sequence[NgwEipAddressArgs]
    expired_time str
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    lock_reason str
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    nat_gateway_id str
    NAT gateway ID.
    nat_gateway_name str
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    nat_ip_addresses Sequence[NgwNatIpAddressArgs]
    network_interface_id str
    Network interface ID occupied by the NAT gateway.
    network_type str
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdue_time str
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period int
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    period_unit str
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    project_name str
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smart_schedule_enabled bool
    Whether to enable intelligent scheduling
    smart_schedule_rule str
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snat_entry_ids Sequence[str]
    SNAT rule ID list
    spec str
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status str
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnet_id str
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags Sequence[NgwTagArgs]
    updated_time str
    Last operation time of the NAT Gateway
    vpc_id str
    ID of the private network where the NAT Gateway is located
    zone_id str
    ID of the primary availability zone the NAT Gateway belongs to
    billingType Number
    NAT Gateway billing mode. Possible values: 1: Subscription. 2 (default): Pay-as-you-go by specification. 3: Pay-as-you-go by usage. When NetworkType is set to intranet, only 3 is supported and required for this parameter.
    businessStatus String
    Indicates whether the NAT gateway is locked. Empty: Normal, not locked. Normal: Normal, not locked. FinancialLocked: Locked due to overdue payment.
    createdTime String
    Creation time
    deletedTime String
    Deletion time
    description String
    Description of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。). Length: 1 to 255 characters. If not specified, defaults to an empty string.
    directMode Boolean
    Indicates whether the NAT is direct or non-direct. - true (default): EIP direct NAT gateway. - false: Non-EIP direct NAT gateway.
    dnatEntryIds List<String>
    DNAT rule ID list.
    eipAddresses List<Property Map>
    expiredTime String
    Expiration time for subscription NAT Gateway. Only NAT Gateways with subscription billing return this parameter.
    lockReason String
    Reason for NAT lock. financial: Locked due to overdue payment. security: Locked for security reasons.
    natGatewayId String
    NAT gateway ID.
    natGatewayName String
    Name of the NAT Gateway. Must start with a letter, Chinese character, or number. Can include period (.), underscore (_), and hyphen (-). Length: 1 to 128 characters. If not specified, defaults to the NAT Gateway instance ID.
    natIpAddresses List<Property Map>
    networkInterfaceId String
    Network interface ID occupied by the NAT gateway.
    networkType String
    NAT Gateway type. internet: Public NAT Gateway. intranet: Private NAT Gateway.
    overdueTime String
    Resource freeze time. This parameter is returned only when the resource is frozen due to overdue payment.
    period Number
    Duration for purchasing a subscription NAT Gateway, default is 1. If PeriodUnit is Month, Period can be 1 ~ 9, 12, 24, 36. If PeriodUnit is Year, Period can be 1 ~ 3.
    periodUnit String
    Unit for subscription NAT Gateway duration, default is Month. Month: month. Year: year.
    projectName String
    Name of the project the NAT Gateway belongs to. If not specified, defaults to the 'default' project.
    smartScheduleEnabled Boolean
    Whether to enable intelligent scheduling
    smartScheduleRule String
    Intelligent scheduling policy rules. ChinaMobile: China Mobile. ChinaUnicom: China Unicom. ChinaTelecom: China Telecom. BGP: BGP multi-line.
    snatEntryIds List<String>
    SNAT rule ID list
    spec String
    NAT Gateway specification. Small (default): Small. Medium: Medium. Large: Large. ExtraLarge1: Extra Large 1. ExtraLarge2: Extra Large 2.
    status String
    Status of the NAT Gateway. Available: Available. Creating: Creating. Pending: In progress. Deleting: Deleting.
    subnetId String
    ID of the subnet where the NAT gateway is located. The input subnet must be a subnet of the private network specified by VpcId. There must be at least one available private IP in the subnet. The system automatically generates a NAT gateway network interface that will occupy one private IP in this subnet. The availability zone of the subnet must have deployed NAT gateway resources. The availability zone of the subnet will be used as the primary availability zone for the NAT gateway and will automatically associate with a backup availability zone. When the primary availability zone fails, the NAT gateway automatically switches to the backup availability zone.
    tags List<Property Map>
    updatedTime String
    Last operation time of the NAT Gateway
    vpcId String
    ID of the private network where the NAT Gateway is located
    zoneId String
    ID of the primary availability zone the NAT Gateway belongs to

    Supporting Types

    NgwEipAddress, NgwEipAddressArgs

    AllocationId string
    Public IP ID
    EipAddress string
    Public IP address
    UsingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    AllocationId string
    Public IP ID
    EipAddress string
    Public IP address
    UsingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId String
    Public IP ID
    eipAddress String
    Public IP address
    usingStatus String
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId string
    Public IP ID
    eipAddress string
    Public IP address
    usingStatus string
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocation_id str
    Public IP ID
    eip_address str
    Public IP address
    using_status str
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    allocationId String
    Public IP ID
    eipAddress String
    Public IP address
    usingStatus String
    Usage status of the public IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.

    NgwNatIpAddress, NgwNatIpAddressArgs

    NatIpAddress string
    Transit IP address
    NatIpId string
    Transit IP ID
    NatIpAddress string
    Transit IP address
    NatIpId string
    Transit IP ID
    natIpAddress String
    Transit IP address
    natIpId String
    Transit IP ID
    natIpAddress string
    Transit IP address
    natIpId string
    Transit IP ID
    nat_ip_address str
    Transit IP address
    nat_ip_id str
    Transit IP ID
    natIpAddress String
    Transit IP address
    natIpId String
    Transit IP ID

    NgwTag, NgwTagArgs

    Key string
    User tag key.
    Value string
    User tag value
    Key string
    User tag key.
    Value string
    User tag value
    key String
    User tag key.
    value String
    User tag value
    key string
    User tag key.
    value string
    User tag value
    key str
    User tag key.
    value str
    User tag value
    key String
    User tag key.
    value String
    User tag value

    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
    Viewing docs for volcenginecc v0.0.32
    published on Thursday, Apr 23, 2026 by Volcengine
    Schema (JSON)
    volcengine/pulumi-volcenginecc
      Try Pulumi Cloud free. Your team will thank you.