1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. VpcPrivateNatGateway
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

tencentcloud.VpcPrivateNatGateway

Explore with Pulumi AI

tencentcloud logo
tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack

    Provides a resource to create a vpc private nat gateway

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as tencentcloud from "@pulumi/tencentcloud";
    
    const privateNatGateway = new tencentcloud.VpcPrivateNatGateway("privateNatGateway", {
        natGatewayName: "xxx",
        vpcId: "xxx",
    });
    
    import pulumi
    import pulumi_tencentcloud as tencentcloud
    
    private_nat_gateway = tencentcloud.VpcPrivateNatGateway("privateNatGateway",
        nat_gateway_name="xxx",
        vpc_id="xxx")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/tencentcloud/tencentcloud"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := tencentcloud.NewVpcPrivateNatGateway(ctx, "privateNatGateway", &tencentcloud.VpcPrivateNatGatewayArgs{
    			NatGatewayName: pulumi.String("xxx"),
    			VpcId:          pulumi.String("xxx"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Tencentcloud = Pulumi.Tencentcloud;
    
    return await Deployment.RunAsync(() => 
    {
        var privateNatGateway = new Tencentcloud.VpcPrivateNatGateway("privateNatGateway", new()
        {
            NatGatewayName = "xxx",
            VpcId = "xxx",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.tencentcloud.VpcPrivateNatGateway;
    import com.pulumi.tencentcloud.VpcPrivateNatGatewayArgs;
    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 privateNatGateway = new VpcPrivateNatGateway("privateNatGateway", VpcPrivateNatGatewayArgs.builder()
                .natGatewayName("xxx")
                .vpcId("xxx")
                .build());
    
        }
    }
    
    resources:
      privateNatGateway:
        type: tencentcloud:VpcPrivateNatGateway
        properties:
          natGatewayName: xxx
          vpcId: xxx
    

    Create VpcPrivateNatGateway Resource

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

    Constructor syntax

    new VpcPrivateNatGateway(name: string, args: VpcPrivateNatGatewayArgs, opts?: CustomResourceOptions);
    @overload
    def VpcPrivateNatGateway(resource_name: str,
                             args: VpcPrivateNatGatewayArgs,
                             opts: Optional[ResourceOptions] = None)
    
    @overload
    def VpcPrivateNatGateway(resource_name: str,
                             opts: Optional[ResourceOptions] = None,
                             nat_gateway_name: Optional[str] = None,
                             ccn_id: Optional[str] = None,
                             cross_domain: Optional[bool] = None,
                             vpc_id: Optional[str] = None,
                             vpc_private_nat_gateway_id: Optional[str] = None,
                             vpc_type: Optional[bool] = None)
    func NewVpcPrivateNatGateway(ctx *Context, name string, args VpcPrivateNatGatewayArgs, opts ...ResourceOption) (*VpcPrivateNatGateway, error)
    public VpcPrivateNatGateway(string name, VpcPrivateNatGatewayArgs args, CustomResourceOptions? opts = null)
    public VpcPrivateNatGateway(String name, VpcPrivateNatGatewayArgs args)
    public VpcPrivateNatGateway(String name, VpcPrivateNatGatewayArgs args, CustomResourceOptions options)
    
    type: tencentcloud:VpcPrivateNatGateway
    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 VpcPrivateNatGatewayArgs
    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 VpcPrivateNatGatewayArgs
    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 VpcPrivateNatGatewayArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VpcPrivateNatGatewayArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VpcPrivateNatGatewayArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

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

    NatGatewayName string
    Private network gateway name.
    CcnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    CrossDomain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    VpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    VpcPrivateNatGatewayId string
    ID of the resource.
    VpcType bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    NatGatewayName string
    Private network gateway name.
    CcnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    CrossDomain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    VpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    VpcPrivateNatGatewayId string
    ID of the resource.
    VpcType bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    natGatewayName String
    Private network gateway name.
    ccnId String
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain Boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    vpcId String
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId String
    ID of the resource.
    vpcType Boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    natGatewayName string
    Private network gateway name.
    ccnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    vpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId string
    ID of the resource.
    vpcType boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    nat_gateway_name str
    Private network gateway name.
    ccn_id str
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    cross_domain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    vpc_id str
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpc_private_nat_gateway_id str
    ID of the resource.
    vpc_type bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    natGatewayName String
    Private network gateway name.
    ccnId String
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain Boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    vpcId String
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId String
    ID of the resource.
    vpcType Boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing VpcPrivateNatGateway Resource

    Get an existing VpcPrivateNatGateway 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?: VpcPrivateNatGatewayState, opts?: CustomResourceOptions): VpcPrivateNatGateway
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            ccn_id: Optional[str] = None,
            cross_domain: Optional[bool] = None,
            nat_gateway_name: Optional[str] = None,
            vpc_id: Optional[str] = None,
            vpc_private_nat_gateway_id: Optional[str] = None,
            vpc_type: Optional[bool] = None) -> VpcPrivateNatGateway
    func GetVpcPrivateNatGateway(ctx *Context, name string, id IDInput, state *VpcPrivateNatGatewayState, opts ...ResourceOption) (*VpcPrivateNatGateway, error)
    public static VpcPrivateNatGateway Get(string name, Input<string> id, VpcPrivateNatGatewayState? state, CustomResourceOptions? opts = null)
    public static VpcPrivateNatGateway get(String name, Output<String> id, VpcPrivateNatGatewayState state, CustomResourceOptions options)
    resources:  _:    type: tencentcloud:VpcPrivateNatGateway    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:
    CcnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    CrossDomain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    NatGatewayName string
    Private network gateway name.
    VpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    VpcPrivateNatGatewayId string
    ID of the resource.
    VpcType bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    CcnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    CrossDomain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    NatGatewayName string
    Private network gateway name.
    VpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    VpcPrivateNatGatewayId string
    ID of the resource.
    VpcType bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    ccnId String
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain Boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    natGatewayName String
    Private network gateway name.
    vpcId String
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId String
    ID of the resource.
    vpcType Boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    ccnId string
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    natGatewayName string
    Private network gateway name.
    vpcId string
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId string
    ID of the resource.
    vpcType boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    ccn_id str
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    cross_domain bool
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    nat_gateway_name str
    Private network gateway name.
    vpc_id str
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpc_private_nat_gateway_id str
    ID of the resource.
    vpc_type bool
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.
    ccnId String
    Cloud Connect Network type The Cloud Connect Network instance ID required to be bound to the private network NAT gateway.
    crossDomain Boolean
    Cross-domain parameters. Cross-domain binding of VPCs is supported only when the value is True.
    natGatewayName String
    Private network gateway name.
    vpcId String
    Private Cloud instance ID. This parameter is required when creating a VPC type private network NAT gateway or a private network NAT gateway of private network gateway.
    vpcPrivateNatGatewayId String
    ID of the resource.
    vpcType Boolean
    VPC type private network NAT gateway. Only when the value is True will a VPC type private network NAT gateway be created.

    Import

    vpc private_nat_gateway can be imported using the id, e.g.

    $ pulumi import tencentcloud:index/vpcPrivateNatGateway:VpcPrivateNatGateway private_nat_gateway private_nat_gateway_id
    

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

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.81.189 published on Wednesday, Apr 30, 2025 by tencentcloudstack