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

volcenginecc.natgateway.NatIp

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

    Allocated from the subnet associated with the private NAT gateway for IP address translation.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as volcenginecc from "@volcengine/pulumi-volcenginecc";

const natGatewayNatIpDemo = new volcenginecc.natgateway.NatIp("NatGatewayNatIpDemo", {
    natGatewayId: "ngw-2hgk22kpfp5a874wjohxxxxx",
    natIpDescription: "NatGatewayNatIpDemo description",
    natIpName: "NatGatewayNatIpDemo",
    natIp: "192.168.xxx.xx",
});

    import pulumi
import pulumi_volcenginecc as volcenginecc

nat_gateway_nat_ip_demo = volcenginecc.natgateway.NatIp("NatGatewayNatIpDemo",
    nat_gateway_id="ngw-2hgk22kpfp5a874wjohxxxxx",
    nat_ip_description="NatGatewayNatIpDemo description",
    nat_ip_name="NatGatewayNatIpDemo",
    nat_ip="192.168.xxx.xx")

    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.NewNatIp(ctx, "NatGatewayNatIpDemo", &natgateway.NatIpArgs{
			NatGatewayId:     pulumi.String("ngw-2hgk22kpfp5a874wjohxxxxx"),
			NatIpDescription: pulumi.String("NatGatewayNatIpDemo description"),
			NatIpName:        pulumi.String("NatGatewayNatIpDemo"),
			NatIp:            pulumi.String("192.168.xxx.xx"),
		})
		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 natGatewayNatIpDemo = new Volcenginecc.Natgateway.NatIp("NatGatewayNatIpDemo", new()
    {
        NatGatewayId = "ngw-2hgk22kpfp5a874wjohxxxxx",
        NatIpDescription = "NatGatewayNatIpDemo description",
        NatIpName = "NatGatewayNatIpDemo",
        NatIpValue = "192.168.xxx.xx",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.volcengine.volcenginecc.natgateway.NatIp;
import com.volcengine.volcenginecc.natgateway.NatIpArgs;
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 natGatewayNatIpDemo = new NatIp("natGatewayNatIpDemo", NatIpArgs.builder()
            .natGatewayId("ngw-2hgk22kpfp5a874wjohxxxxx")
            .natIpDescription("NatGatewayNatIpDemo description")
            .natIpName("NatGatewayNatIpDemo")
            .natIp("192.168.xxx.xx")
            .build());

    }
}

    resources:
  natGatewayNatIpDemo:
    type: volcenginecc:natgateway:NatIp
    name: NatGatewayNatIpDemo
    properties:
      natGatewayId: ngw-2hgk22kpfp5a874wjohxxxxx
      natIpDescription: NatGatewayNatIpDemo description
      natIpName: NatGatewayNatIpDemo
      natIp: 192.168.xxx.xx

    Create NatIp Resource

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

    Constructor syntax

    new NatIp(name: string, args: NatIpArgs, opts?: CustomResourceOptions);
    @overload
def NatIp(resource_name: str,
          args: NatIpArgs,
          opts: Optional[ResourceOptions] = None)

@overload
def NatIp(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          nat_gateway_id: Optional[str] = None,
          nat_ip: Optional[str] = None,
          nat_ip_description: Optional[str] = None,
          nat_ip_name: Optional[str] = None)
    func NewNatIp(ctx *Context, name string, args NatIpArgs, opts ...ResourceOption) (*NatIp, error)
    public NatIp(string name, NatIpArgs args, CustomResourceOptions? opts = null)
    public NatIp(String name, NatIpArgs args)
public NatIp(String name, NatIpArgs args, CustomResourceOptions options)

    type: volcenginecc:natgateway:NatIp
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 NatIpArgs
    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 NatIpArgs
    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 NatIpArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args NatIpArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args NatIpArgs
    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 natIpResource = new Volcenginecc.Natgateway.NatIp("natIpResource", new()
{
    NatGatewayId = "string",
    NatIpValue = "string",
    NatIpDescription = "string",
    NatIpName = "string",
});

    example, err := natgateway.NewNatIp(ctx, "natIpResource", &natgateway.NatIpArgs{
	NatGatewayId:     pulumi.String("string"),
	NatIp:            pulumi.String("string"),
	NatIpDescription: pulumi.String("string"),
	NatIpName:        pulumi.String("string"),
})

    var natIpResource = new NatIp("natIpResource", NatIpArgs.builder()
    .natGatewayId("string")
    .natIp("string")
    .natIpDescription("string")
    .natIpName("string")
    .build());

    nat_ip_resource = volcenginecc.natgateway.NatIp("natIpResource",
    nat_gateway_id="string",
    nat_ip="string",
    nat_ip_description="string",
    nat_ip_name="string")

    const natIpResource = new volcenginecc.natgateway.NatIp("natIpResource", {
    natGatewayId: "string",
    natIp: "string",
    natIpDescription: "string",
    natIpName: "string",
});

    type: volcenginecc:natgateway:NatIp
properties:
    natGatewayId: string
    natIp: string
    natIpDescription: string
    natIpName: string

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

    NatGatewayId string
    Private NAT gateway ID.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    NatIpValue string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    NatGatewayId string
    Private NAT gateway ID.
    NatIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    natGatewayId string
    Private NAT gateway ID.
    natIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    nat_gateway_id str
    Private NAT gateway ID.
    nat_ip str
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    nat_ip_description str
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    nat_ip_name str
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatIpId string
    Transit IP ID.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatIpId string
    Transit IP ID.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natIpId String
    Transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id string
    The provider-assigned unique ID for this managed resource.
    isDefault boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natIpId string
    Transit IP ID.
    status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id str
    The provider-assigned unique ID for this managed resource.
    is_default bool
    Whether this is the default transit IP. true: Yes. false: No.
    nat_ip_id str
    Transit IP ID.
    status str
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    using_status str
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    id String
    The provider-assigned unique ID for this managed resource.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natIpId String
    Transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.

    Look up Existing NatIp Resource

    Get an existing NatIp 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?: NatIpState, opts?: CustomResourceOptions): NatIp
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        is_default: Optional[bool] = None,
        nat_gateway_id: Optional[str] = None,
        nat_ip: Optional[str] = None,
        nat_ip_description: Optional[str] = None,
        nat_ip_id: Optional[str] = None,
        nat_ip_name: Optional[str] = None,
        status: Optional[str] = None,
        using_status: Optional[str] = None) -> NatIp
    func GetNatIp(ctx *Context, name string, id IDInput, state *NatIpState, opts ...ResourceOption) (*NatIp, error)
    public static NatIp Get(string name, Input<string> id, NatIpState? state, CustomResourceOptions? opts = null)
    public static NatIp get(String name, Output<String> id, NatIpState state, CustomResourceOptions options)
    resources:  _:    type: volcenginecc:natgateway:NatIp    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:
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatGatewayId string
    Private NAT gateway ID.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpId string
    Transit IP ID.
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    NatIpValue string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    IsDefault bool
    Whether this is the default transit IP. true: Yes. false: No.
    NatGatewayId string
    Private NAT gateway ID.
    NatIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    NatIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    NatIpId string
    Transit IP ID.
    NatIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    Status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    UsingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId String
    Transit IP ID.
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    isDefault boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId string
    Private NAT gateway ID.
    natIp string
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription string
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId string
    Transit IP ID.
    natIpName string
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status string
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus string
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    is_default bool
    Whether this is the default transit IP. true: Yes. false: No.
    nat_gateway_id str
    Private NAT gateway ID.
    nat_ip str
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    nat_ip_description str
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    nat_ip_id str
    Transit IP ID.
    nat_ip_name str
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status str
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    using_status str
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.
    isDefault Boolean
    Whether this is the default transit IP. true: Yes. false: No.
    natGatewayId String
    Private NAT gateway ID.
    natIp String
    Transit IP address. If not specified, the system automatically randomly assigns an available IP address from the subnet of the private NAT gateway.
    natIpDescription String
    Description of the transit IP. Length limit: 0–255 characters. If not specified, defaults to an empty string. Must start with a letter, Chinese character, or number. Can include English comma (,), period (.), underscore (_), space ( ), equals sign (=), hyphen (-), Chinese comma (，), and Chinese period (。).
    natIpId String
    Transit IP ID.
    natIpName String
    Name of the transit IP. Length limit: 1–128 characters. Must start with a letter, Chinese character, or number; can include period (.), underscore (_), and hyphen (-). If not specified, defaults to the transit IP ID.
    status String
    Status of the transit IP. Creating: Being created. Available: Available. Deleting: Being deleted. Deleted: Deleted.
    usingStatus String
    Usage status of the transit IP. Idle: Not used. UsedBySnat: Used by SNAT rule. UsedByDnat: Used by DNAT rule. UsedByNat: Used by both SNAT and DNAT rules.

    Import

    $ pulumi import volcenginecc:natgateway/natIp:NatIp example "nat_ip_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.