1. Packages
  2. Tencentcloud Provider
  3. API Docs
  4. getNatGateways
tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack

tencentcloud.getNatGateways

Explore with Pulumi AI

tencentcloud 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack

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({
    id: "nat-xfaq1",
    name: "main",
    vpcId: "vpc-xfqag",
});
Copy
import pulumi
import pulumi_tencentcloud as tencentcloud

foo = tencentcloud.get_nat_gateways(id="nat-xfaq1",
    name="main",
    vpc_id="vpc-xfqag")
Copy
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{
			Id:    pulumi.StringRef("nat-xfaq1"),
			Name:  pulumi.StringRef("main"),
			VpcId: pulumi.StringRef("vpc-xfqag"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Tencentcloud = Pulumi.Tencentcloud;

return await Deployment.RunAsync(() => 
{
    var foo = Tencentcloud.GetNatGateways.Invoke(new()
    {
        Id = "nat-xfaq1",
        Name = "main",
        VpcId = "vpc-xfqag",
    });

});
Copy
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()
            .id("nat-xfaq1")
            .name("main")
            .vpcId("vpc-xfqag")
            .build());

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

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>
Copy
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]
Copy
func GetNatGateways(ctx *Context, args *GetNatGatewaysArgs, opts ...InvokeOption) (*GetNatGatewaysResult, error)
func GetNatGatewaysOutput(ctx *Context, args *GetNatGatewaysOutputArgs, opts ...InvokeOption) GetNatGatewaysResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)
public static Output<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: tencentcloud:index/getNatGateways:getNatGateways
  arguments:
    # arguments dictionary
Copy

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 This property is required. List<string>
EIP IP address set bound to the gateway. The value of at least 1.
Bandwidth This property is required. 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 This property is required. string
Create time of the NAT gateway.
Id This property is required. string
ID of the NAT gateway.
MaxConcurrent This property is required. double
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
Name This property is required. string
Name of the NAT gateway.
State This property is required. string
State of the NAT gateway.
Tags This property is required. Dictionary<string, string>
The available tags within this NAT gateway.
VpcId This property is required. string
ID of the VPC.
AssignedEipSets This property is required. []string
EIP IP address set bound to the gateway. The value of at least 1.
Bandwidth This property is required. 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 This property is required. string
Create time of the NAT gateway.
Id This property is required. string
ID of the NAT gateway.
MaxConcurrent This property is required. float64
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
Name This property is required. string
Name of the NAT gateway.
State This property is required. string
State of the NAT gateway.
Tags This property is required. map[string]string
The available tags within this NAT gateway.
VpcId This property is required. string
ID of the VPC.
assignedEipSets This property is required. List<String>
EIP IP address set bound to the gateway. The value of at least 1.
bandwidth This property is required. 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 This property is required. String
Create time of the NAT gateway.
id This property is required. String
ID of the NAT gateway.
maxConcurrent This property is required. Double
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
name This property is required. String
Name of the NAT gateway.
state This property is required. String
State of the NAT gateway.
tags This property is required. Map<String,String>
The available tags within this NAT gateway.
vpcId This property is required. String
ID of the VPC.
assignedEipSets This property is required. string[]
EIP IP address set bound to the gateway. The value of at least 1.
bandwidth This property is required. 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 This property is required. string
Create time of the NAT gateway.
id This property is required. string
ID of the NAT gateway.
maxConcurrent This property is required. number
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
name This property is required. string
Name of the NAT gateway.
state This property is required. string
State of the NAT gateway.
tags This property is required. {[key: string]: string}
The available tags within this NAT gateway.
vpcId This property is required. string
ID of the VPC.
assigned_eip_sets This property is required. Sequence[str]
EIP IP address set bound to the gateway. The value of at least 1.
bandwidth This property is required. 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 This property is required. str
Create time of the NAT gateway.
id This property is required. str
ID of the NAT gateway.
max_concurrent This property is required. float
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
name This property is required. str
Name of the NAT gateway.
state This property is required. str
State of the NAT gateway.
tags This property is required. Mapping[str, str]
The available tags within this NAT gateway.
vpc_id This property is required. str
ID of the VPC.
assignedEipSets This property is required. List<String>
EIP IP address set bound to the gateway. The value of at least 1.
bandwidth This property is required. 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 This property is required. String
Create time of the NAT gateway.
id This property is required. String
ID of the NAT gateway.
maxConcurrent This property is required. Number
The upper limit of concurrent connection of NAT gateway, the available values include: 1000000,3000000,10000000. Default is 1000000.
name This property is required. String
Name of the NAT gateway.
state This property is required. String
State of the NAT gateway.
tags This property is required. Map<String>
The available tags within this NAT gateway.
vpcId This property is required. 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 1.81.182 published on Monday, Apr 14, 2025 by tencentcloudstack