Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Flexibleengine Provider
  3. API Docs
  4. NatPrivateTransitIp
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

flexibleengine.NatPrivateTransitIp

Explore with Pulumi AI

flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine

Manages a transit IP resource of the private NAT within FlexibleEngine.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as flexibleengine from "@pulumi/flexibleengine";

const config = new pulumi.Config();
const subnetId = config.requireObject("subnetId");
const ipv4Address = config.requireObject("ipv4Address");
const enterpriseProjectId = config.requireObject("enterpriseProjectId");
const test = new flexibleengine.NatPrivateTransitIp("test", {
    subnetId: subnetId,
    ipAddress: ipv4Address,
    enterpriseProjectId: enterpriseProjectId,
    tags: {
        foo: "bar",
    },
});
Copy
import pulumi
import pulumi_flexibleengine as flexibleengine

config = pulumi.Config()
subnet_id = config.require_object("subnetId")
ipv4_address = config.require_object("ipv4Address")
enterprise_project_id = config.require_object("enterpriseProjectId")
test = flexibleengine.NatPrivateTransitIp("test",
    subnet_id=subnet_id,
    ip_address=ipv4_address,
    enterprise_project_id=enterprise_project_id,
    tags={
        "foo": "bar",
    })
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/flexibleengine/flexibleengine"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		subnetId := cfg.RequireObject("subnetId")
		ipv4Address := cfg.RequireObject("ipv4Address")
		enterpriseProjectId := cfg.RequireObject("enterpriseProjectId")
		_, err := flexibleengine.NewNatPrivateTransitIp(ctx, "test", &flexibleengine.NatPrivateTransitIpArgs{
			SubnetId:            pulumi.Any(subnetId),
			IpAddress:           pulumi.Any(ipv4Address),
			EnterpriseProjectId: pulumi.Any(enterpriseProjectId),
			Tags: pulumi.StringMap{
				"foo": pulumi.String("bar"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Flexibleengine = Pulumi.Flexibleengine;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var subnetId = config.RequireObject<dynamic>("subnetId");
    var ipv4Address = config.RequireObject<dynamic>("ipv4Address");
    var enterpriseProjectId = config.RequireObject<dynamic>("enterpriseProjectId");
    var test = new Flexibleengine.NatPrivateTransitIp("test", new()
    {
        SubnetId = subnetId,
        IpAddress = ipv4Address,
        EnterpriseProjectId = enterpriseProjectId,
        Tags = 
        {
            { "foo", "bar" },
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.flexibleengine.NatPrivateTransitIp;
import com.pulumi.flexibleengine.NatPrivateTransitIpArgs;
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) {
        final var config = ctx.config();
        final var subnetId = config.get("subnetId");
        final var ipv4Address = config.get("ipv4Address");
        final var enterpriseProjectId = config.get("enterpriseProjectId");
        var test = new NatPrivateTransitIp("test", NatPrivateTransitIpArgs.builder()
            .subnetId(subnetId)
            .ipAddress(ipv4Address)
            .enterpriseProjectId(enterpriseProjectId)
            .tags(Map.of("foo", "bar"))
            .build());

    }
}
Copy
configuration:
  subnetId:
    type: dynamic
  ipv4Address:
    type: dynamic
  enterpriseProjectId:
    type: dynamic
resources:
  test:
    type: flexibleengine:NatPrivateTransitIp
    properties:
      subnetId: ${subnetId}
      ipAddress: ${ipv4Address}
      enterpriseProjectId: ${enterpriseProjectId}
      tags:
        foo: bar
Copy

Create NatPrivateTransitIp Resource

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

Constructor syntax

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

@overload
def NatPrivateTransitIp(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        subnet_id: Optional[str] = None,
                        enterprise_project_id: Optional[str] = None,
                        ip_address: Optional[str] = None,
                        nat_private_transit_ip_id: Optional[str] = None,
                        region: Optional[str] = None,
                        tags: Optional[Mapping[str, str]] = None)
func NewNatPrivateTransitIp(ctx *Context, name string, args NatPrivateTransitIpArgs, opts ...ResourceOption) (*NatPrivateTransitIp, error)
public NatPrivateTransitIp(string name, NatPrivateTransitIpArgs args, CustomResourceOptions? opts = null)
public NatPrivateTransitIp(String name, NatPrivateTransitIpArgs args)
public NatPrivateTransitIp(String name, NatPrivateTransitIpArgs args, CustomResourceOptions options)

type: flexibleengine:NatPrivateTransitIp
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NatPrivateTransitIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NatPrivateTransitIpArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NatPrivateTransitIpArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NatPrivateTransitIpArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NatPrivateTransitIpArgs
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 natPrivateTransitIpResource = new Flexibleengine.NatPrivateTransitIp("natPrivateTransitIpResource", new()
{
    SubnetId = "string",
    EnterpriseProjectId = "string",
    IpAddress = "string",
    NatPrivateTransitIpId = "string",
    Region = "string",
    Tags = 
    {
        { "string", "string" },
    },
});
Copy
example, err := flexibleengine.NewNatPrivateTransitIp(ctx, "natPrivateTransitIpResource", &flexibleengine.NatPrivateTransitIpArgs{
	SubnetId:              pulumi.String("string"),
	EnterpriseProjectId:   pulumi.String("string"),
	IpAddress:             pulumi.String("string"),
	NatPrivateTransitIpId: pulumi.String("string"),
	Region:                pulumi.String("string"),
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})
Copy
var natPrivateTransitIpResource = new NatPrivateTransitIp("natPrivateTransitIpResource", NatPrivateTransitIpArgs.builder()
    .subnetId("string")
    .enterpriseProjectId("string")
    .ipAddress("string")
    .natPrivateTransitIpId("string")
    .region("string")
    .tags(Map.of("string", "string"))
    .build());
Copy
nat_private_transit_ip_resource = flexibleengine.NatPrivateTransitIp("natPrivateTransitIpResource",
    subnet_id="string",
    enterprise_project_id="string",
    ip_address="string",
    nat_private_transit_ip_id="string",
    region="string",
    tags={
        "string": "string",
    })
Copy
const natPrivateTransitIpResource = new flexibleengine.NatPrivateTransitIp("natPrivateTransitIpResource", {
    subnetId: "string",
    enterpriseProjectId: "string",
    ipAddress: "string",
    natPrivateTransitIpId: "string",
    region: "string",
    tags: {
        string: "string",
    },
});
Copy
type: flexibleengine:NatPrivateTransitIp
properties:
    enterpriseProjectId: string
    ipAddress: string
    natPrivateTransitIpId: string
    region: string
    subnetId: string
    tags:
        string: string
Copy

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

SubnetId This property is required. string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
EnterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
IpAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
NatPrivateTransitIpId string
The resource ID in UUID format.
Region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Tags Dictionary<string, string>
Specifies the key/value pairs to associate with the transit IP.
SubnetId This property is required. string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
EnterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
IpAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
NatPrivateTransitIpId string
The resource ID in UUID format.
Region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
Tags map[string]string
Specifies the key/value pairs to associate with the transit IP.
subnetId This property is required. String
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
enterpriseProjectId String
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
ipAddress String
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId String
The resource ID in UUID format.
region String
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
tags Map<String,String>
Specifies the key/value pairs to associate with the transit IP.
subnetId This property is required. string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
enterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
ipAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId string
The resource ID in UUID format.
region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
tags {[key: string]: string}
Specifies the key/value pairs to associate with the transit IP.
subnet_id This property is required. str
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
enterprise_project_id str
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
ip_address str
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
nat_private_transit_ip_id str
The resource ID in UUID format.
region str
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
tags Mapping[str, str]
Specifies the key/value pairs to associate with the transit IP.
subnetId This property is required. String
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
enterpriseProjectId String
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
ipAddress String
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId String
The resource ID in UUID format.
region String
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
tags Map<String>
Specifies the key/value pairs to associate with the transit IP.

Outputs

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

CreatedAt string
The creation time of the transit IP for private NAT.
GatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceId string
The network interface ID of the transit IP for private NAT.
UpdatedAt string
The latest update time of the transit IP for private NAT.
CreatedAt string
The creation time of the transit IP for private NAT.
GatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
Id string
The provider-assigned unique ID for this managed resource.
NetworkInterfaceId string
The network interface ID of the transit IP for private NAT.
UpdatedAt string
The latest update time of the transit IP for private NAT.
createdAt String
The creation time of the transit IP for private NAT.
gatewayId String
The ID of the private NAT gateway to which the transit IP belongs.
id String
The provider-assigned unique ID for this managed resource.
networkInterfaceId String
The network interface ID of the transit IP for private NAT.
updatedAt String
The latest update time of the transit IP for private NAT.
createdAt string
The creation time of the transit IP for private NAT.
gatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
id string
The provider-assigned unique ID for this managed resource.
networkInterfaceId string
The network interface ID of the transit IP for private NAT.
updatedAt string
The latest update time of the transit IP for private NAT.
created_at str
The creation time of the transit IP for private NAT.
gateway_id str
The ID of the private NAT gateway to which the transit IP belongs.
id str
The provider-assigned unique ID for this managed resource.
network_interface_id str
The network interface ID of the transit IP for private NAT.
updated_at str
The latest update time of the transit IP for private NAT.
createdAt String
The creation time of the transit IP for private NAT.
gatewayId String
The ID of the private NAT gateway to which the transit IP belongs.
id String
The provider-assigned unique ID for this managed resource.
networkInterfaceId String
The network interface ID of the transit IP for private NAT.
updatedAt String
The latest update time of the transit IP for private NAT.

Look up Existing NatPrivateTransitIp Resource

Get an existing NatPrivateTransitIp 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?: NatPrivateTransitIpState, opts?: CustomResourceOptions): NatPrivateTransitIp
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        created_at: Optional[str] = None,
        enterprise_project_id: Optional[str] = None,
        gateway_id: Optional[str] = None,
        ip_address: Optional[str] = None,
        nat_private_transit_ip_id: Optional[str] = None,
        network_interface_id: Optional[str] = None,
        region: Optional[str] = None,
        subnet_id: Optional[str] = None,
        tags: Optional[Mapping[str, str]] = None,
        updated_at: Optional[str] = None) -> NatPrivateTransitIp
func GetNatPrivateTransitIp(ctx *Context, name string, id IDInput, state *NatPrivateTransitIpState, opts ...ResourceOption) (*NatPrivateTransitIp, error)
public static NatPrivateTransitIp Get(string name, Input<string> id, NatPrivateTransitIpState? state, CustomResourceOptions? opts = null)
public static NatPrivateTransitIp get(String name, Output<String> id, NatPrivateTransitIpState state, CustomResourceOptions options)
resources:  _:    type: flexibleengine:NatPrivateTransitIp    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
CreatedAt string
The creation time of the transit IP for private NAT.
EnterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
GatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
IpAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
NatPrivateTransitIpId string
The resource ID in UUID format.
NetworkInterfaceId string
The network interface ID of the transit IP for private NAT.
Region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
SubnetId string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
Tags Dictionary<string, string>
Specifies the key/value pairs to associate with the transit IP.
UpdatedAt string
The latest update time of the transit IP for private NAT.
CreatedAt string
The creation time of the transit IP for private NAT.
EnterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
GatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
IpAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
NatPrivateTransitIpId string
The resource ID in UUID format.
NetworkInterfaceId string
The network interface ID of the transit IP for private NAT.
Region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
SubnetId string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
Tags map[string]string
Specifies the key/value pairs to associate with the transit IP.
UpdatedAt string
The latest update time of the transit IP for private NAT.
createdAt String
The creation time of the transit IP for private NAT.
enterpriseProjectId String
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
gatewayId String
The ID of the private NAT gateway to which the transit IP belongs.
ipAddress String
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId String
The resource ID in UUID format.
networkInterfaceId String
The network interface ID of the transit IP for private NAT.
region String
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
subnetId String
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
tags Map<String,String>
Specifies the key/value pairs to associate with the transit IP.
updatedAt String
The latest update time of the transit IP for private NAT.
createdAt string
The creation time of the transit IP for private NAT.
enterpriseProjectId string
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
gatewayId string
The ID of the private NAT gateway to which the transit IP belongs.
ipAddress string
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId string
The resource ID in UUID format.
networkInterfaceId string
The network interface ID of the transit IP for private NAT.
region string
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
subnetId string
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
tags {[key: string]: string}
Specifies the key/value pairs to associate with the transit IP.
updatedAt string
The latest update time of the transit IP for private NAT.
created_at str
The creation time of the transit IP for private NAT.
enterprise_project_id str
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
gateway_id str
The ID of the private NAT gateway to which the transit IP belongs.
ip_address str
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
nat_private_transit_ip_id str
The resource ID in UUID format.
network_interface_id str
The network interface ID of the transit IP for private NAT.
region str
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
subnet_id str
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
tags Mapping[str, str]
Specifies the key/value pairs to associate with the transit IP.
updated_at str
The latest update time of the transit IP for private NAT.
createdAt String
The creation time of the transit IP for private NAT.
enterpriseProjectId String
Specifies the ID of the enterprise project to which the transit IP belongs. Changing this will create a new resource.
gatewayId String
The ID of the private NAT gateway to which the transit IP belongs.
ipAddress String
Specifies the IP address of the transit subnet.
Changing this will create a new resource.
natPrivateTransitIpId String
The resource ID in UUID format.
networkInterfaceId String
The network interface ID of the transit IP for private NAT.
region String
Specifies the region where the transit IP is located.
If omitted, the provider-level region will be used. Changing this will create a new resource.
subnetId String
Specifies the transit subnet ID to which the transit IP belongs.
Changing this will create a new resource.
tags Map<String>
Specifies the key/value pairs to associate with the transit IP.
updatedAt String
The latest update time of the transit IP for private NAT.

Import

Transit IPs can be imported using their id, e.g.

bash

$ pulumi import flexibleengine:index/natPrivateTransitIp:NatPrivateTransitIp test 5a1d921c-1df5-477d-8481-317b3fb47b5d
Copy

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

Package Details

Repository
flexibleengine flexibleenginecloud/terraform-provider-flexibleengine
License
Notes
This Pulumi package is based on the flexibleengine Terraform Provider.
flexibleengine 1.46.0 published on Monday, Apr 14, 2025 by flexibleenginecloud
flexibleenginecloud/terraform-provider-flexibleengine