1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getNatGateways
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

tencentcloud.getNatGateways

Start a Neo task
Explain and create a tencentcloud.getNatGateways resource
tencentcloud logo
tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
tencentcloudstack/terraform-provider-tencentcloud

    Use this data source to query detailed information of NAT gateways.

    Example Usage

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

const foo = tencentcloud.getNatGateways({
    name: "main",
    vpcId: "vpc-xfqag",
    id: "nat-xfaq1",
});

    import pulumi
import pulumi_tencentcloud as tencentcloud

foo = tencentcloud.get_nat_gateways(name="main",
    vpc_id="vpc-xfqag",
    id="nat-xfaq1")

    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.GetNatGateways(ctx, &tencentcloud.GetNatGatewaysArgs{
			Name:  pulumi.StringRef("main"),
			VpcId: pulumi.StringRef("vpc-xfqag"),
			Id:    pulumi.StringRef("nat-xfaq1"),
		}, nil)
		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 foo = Tencentcloud.GetNatGateways.Invoke(new()
    {
        Name = "main",
        VpcId = "vpc-xfqag",
        Id = "nat-xfaq1",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.tencentcloud.TencentcloudFunctions;
import com.pulumi.tencentcloud.inputs.GetNatGatewaysArgs;
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 foo = TencentcloudFunctions.getNatGateways(GetNatGatewaysArgs.builder()
            .name("main")
            .vpcId("vpc-xfqag")
            .id("nat-xfaq1")
            .build());

    }
}

    variables:
  foo:
    fn::invoke:
      function: tencentcloud:getNatGateways
      arguments:
        name: main
        vpcId: vpc-xfqag
        id: nat-xfaq1

    Using getNatGateways

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getNatGateways(args: GetNatGatewaysArgs, opts?: InvokeOptions): Promise<GetNatGatewaysResult>
function getNatGatewaysOutput(args: GetNatGatewaysOutputArgs, opts?: InvokeOptions): Output<GetNatGatewaysResult>
    def get_nat_gateways(id: Optional[str] = None,
                     name: Optional[str] = None,
                     result_output_file: Optional[str] = None,
                     vpc_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNatGatewaysResult
def get_nat_gateways_output(id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     result_output_file: Optional[pulumi.Input[str]] = None,
                     vpc_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewaysResult]
    func GetNatGateways(ctx *Context, args *GetNatGatewaysArgs, opts ...InvokeOption) (*GetNatGatewaysResult, error)
func GetNatGatewaysOutput(ctx *Context, args *GetNatGatewaysOutputArgs, opts ...InvokeOption) GetNatGatewaysResultOutput

    > Note: This function is named GetNatGateways in the Go SDK.

    public static class GetNatGateways 
{
    public static Task<GetNatGatewaysResult> InvokeAsync(GetNatGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetNatGatewaysResult> Invoke(GetNatGatewaysInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)
public static Output<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)

    fn::invoke:
  function: tencentcloud:index/getNatGateways:getNatGateways
  arguments:
    # arguments dictionary

    The following arguments are supported:

    Id string
    ID of the NAT gateway.
    Name string
    Name of the NAT gateway.
    ResultOutputFile string
    Used to save results.
    VpcId string
    ID of the VPC.
    Id string
    ID of the NAT gateway.
    Name string
    Name of the NAT gateway.
    ResultOutputFile string
    Used to save results.
    VpcId string
    ID of the VPC.
    id String
    ID of the NAT gateway.
    name String
    Name of the NAT gateway.
    resultOutputFile String
    Used to save results.
    vpcId String
    ID of the VPC.
    id string
    ID of the NAT gateway.
    name string
    Name of the NAT gateway.
    resultOutputFile string
    Used to save results.
    vpcId string
    ID of the VPC.
    id str
    ID of the NAT gateway.
    name str
    Name of the NAT gateway.
    result_output_file str
    Used to save results.
    vpc_id str
    ID of the VPC.
    id String
    ID of the NAT gateway.
    name String
    Name of the NAT gateway.
    resultOutputFile String
    Used to save results.
    vpcId String
    ID of the VPC.

    getNatGateways Result

    The following output properties are available:

    Nats List<GetNatGatewaysNat>
    Information list of the dedicated NATs.
    Id string
    ID of the NAT gateway.
    Name string
    Name of the NAT gateway.
    ResultOutputFile string
    VpcId string
    ID of the VPC.
    Nats []GetNatGatewaysNat
    Information list of the dedicated NATs.
    Id string
    ID of the NAT gateway.
    Name string
    Name of the NAT gateway.
    ResultOutputFile string
    VpcId string
    ID of the VPC.
    nats List<GetNatGatewaysNat>
    Information list of the dedicated NATs.
    id String
    ID of the NAT gateway.
    name String
    Name of the NAT gateway.
    resultOutputFile String
    vpcId String
    ID of the VPC.
    nats GetNatGatewaysNat[]
    Information list of the dedicated NATs.
    id string
    ID of the NAT gateway.
    name string
    Name of the NAT gateway.
    resultOutputFile string
    vpcId string
    ID of the VPC.
    nats Sequence[GetNatGatewaysNat]
    Information list of the dedicated NATs.
    id str
    ID of the NAT gateway.
    name str
    Name of the NAT gateway.
    result_output_file str
    vpc_id str
    ID of the VPC.
    nats List<Property Map>
    Information list of the dedicated NATs.
    id String
    ID of the NAT gateway.
    name String
    Name of the NAT gateway.
    resultOutputFile String
    vpcId String
    ID of the VPC.

    Supporting Types

    GetNatGatewaysNat

    AssignedEipSets List<string>
    EIP IP address set bound to the gateway. The value of at least 1.
    Bandwidth double
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    CreateTime string
    Create time of the NAT gateway.
    Id string
    ID of the NAT gateway.
    MaxConcurrent double
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    Name string
    Name of the NAT gateway.
    State string
    State of the NAT gateway.
    Tags Dictionary<string, string>
    The available tags within this NAT gateway.
    VpcId string
    ID of the VPC.
    AssignedEipSets []string
    EIP IP address set bound to the gateway. The value of at least 1.
    Bandwidth float64
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    CreateTime string
    Create time of the NAT gateway.
    Id string
    ID of the NAT gateway.
    MaxConcurrent float64
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    Name string
    Name of the NAT gateway.
    State string
    State of the NAT gateway.
    Tags map[string]string
    The available tags within this NAT gateway.
    VpcId string
    ID of the VPC.
    assignedEipSets List<String>
    EIP IP address set bound to the gateway. The value of at least 1.
    bandwidth Double
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    createTime String
    Create time of the NAT gateway.
    id String
    ID of the NAT gateway.
    maxConcurrent Double
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    name String
    Name of the NAT gateway.
    state String
    State of the NAT gateway.
    tags Map<String,String>
    The available tags within this NAT gateway.
    vpcId String
    ID of the VPC.
    assignedEipSets string[]
    EIP IP address set bound to the gateway. The value of at least 1.
    bandwidth number
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    createTime string
    Create time of the NAT gateway.
    id string
    ID of the NAT gateway.
    maxConcurrent number
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    name string
    Name of the NAT gateway.
    state string
    State of the NAT gateway.
    tags {[key: string]: string}
    The available tags within this NAT gateway.
    vpcId string
    ID of the VPC.
    assigned_eip_sets Sequence[str]
    EIP IP address set bound to the gateway. The value of at least 1.
    bandwidth float
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    create_time str
    Create time of the NAT gateway.
    id str
    ID of the NAT gateway.
    max_concurrent float
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    name str
    Name of the NAT gateway.
    state str
    State of the NAT gateway.
    tags Mapping[str, str]
    The available tags within this NAT gateway.
    vpc_id str
    ID of the VPC.
    assignedEipSets List<String>
    EIP IP address set bound to the gateway. The value of at least 1.
    bandwidth Number
    The maximum public network output bandwidth of NAT gateway (unit: Mbps), the available values include: 20,50,100,200,500,1000,2000,5000. Default is 100.
    createTime String
    Create time of the NAT gateway.
    id String
    ID of the NAT gateway.
    maxConcurrent Number
    The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
    name String
    Name of the NAT gateway.
    state String
    State of the NAT gateway.
    tags Map<String>
    The available tags within this NAT gateway.
    vpcId String
    ID of the VPC.

    Package Details

    Repository
    tencentcloud tencentcloudstack/terraform-provider-tencentcloud
    License
    Notes
    This Pulumi package is based on the tencentcloud Terraform Provider.
    tencentcloud logo
    tencentcloud 1.82.35 published on Friday, Nov 7, 2025 by tencentcloudstack
    tencentcloudstack/terraform-provider-tencentcloud
      Meet Neo: Your AI Platform Teammate