pulumi-aws-kotlin/com.pulumi.aws.ec2.kotlin/Ec2Functions/getNatGateway

getNatGateway

suspend fun getNatGateway(argument: GetNatGatewayPlainArgs): GetNatGatewayResult

Provides details about a specific VPC NAT Gateway.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = aws.ec2.getNatGateway({
    subnetId: _public.id,
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
default = aws.ec2.get_nat_gateway(subnet_id=public["id"])
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var @default = Aws.Ec2.GetNatGateway.Invoke(new()
    {
        SubnetId = @public.Id,
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupNatGateway(ctx, &ec2.LookupNatGatewayArgs{
			SubnetId: pulumi.StringRef(public.Id),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetNatGatewayArgs;
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 default = Ec2Functions.getNatGateway(GetNatGatewayArgs.builder()
            .subnetId(public_.id())
            .build());
    }
}
Content copied to clipboard
variables:
  default:
    fn::invoke:
      function: aws:ec2:getNatGateway
      arguments:
        subnetId: ${public.id}
Content copied to clipboard

With tags

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";
const _default = aws.ec2.getNatGateway({
    subnetId: _public.id,
    tags: {
        Name: "gw NAT",
    },
});
Content copied to clipboard
import pulumi
import pulumi_aws as aws
default = aws.ec2.get_nat_gateway(subnet_id=public["id"],
    tags={
        "Name": "gw NAT",
    })
Content copied to clipboard
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;
return await Deployment.RunAsync(() =>
{
    var @default = Aws.Ec2.GetNatGateway.Invoke(new()
    {
        SubnetId = @public.Id,
        Tags =
        {
            { "Name", "gw NAT" },
        },
    });
});
Content copied to clipboard
package main
import (
	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := ec2.LookupNatGateway(ctx, &ec2.LookupNatGatewayArgs{
			SubnetId: pulumi.StringRef(public.Id),
			Tags: map[string]interface{}{
				"Name": "gw NAT",
			},
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Content copied to clipboard
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.ec2.Ec2Functions;
import com.pulumi.aws.ec2.inputs.GetNatGatewayArgs;
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 default = Ec2Functions.getNatGateway(GetNatGatewayArgs.builder()
            .subnetId(public_.id())
            .tags(Map.of("Name", "gw NAT"))
            .build());
    }
}
Content copied to clipboard
variables:
  default:
    fn::invoke:
      function: aws:ec2:getNatGateway
      arguments:
        subnetId: ${public.id}
        tags:
          Name: gw NAT
Content copied to clipboard

Return

A collection of values returned by getNatGateway.

Parameters

argument

A collection of arguments for invoking getNatGateway.

suspend fun getNatGateway(filters: List<GetNatGatewayFilter>? = null, id: String? = null, state: String? = null, subnetId: String? = null, tags: Map<String, String>? = null, vpcId: String? = null): GetNatGatewayResult

Return

A collection of values returned by getNatGateway.

Parameters

filters

Custom filter block as described below. More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

id

ID of the specific NAT Gateway to retrieve.

state

State of the NAT Gateway (pending | failed | available | deleting | deleted ).

subnetId

ID of subnet that the NAT Gateway resides in.

tags

Map of tags, each pair of which must exactly match a pair on the desired NAT Gateway.

vpcId

ID of the VPC that the NAT Gateway resides in.

See also

.

suspend fun getNatGateway(argument: suspend GetNatGatewayPlainArgsBuilder.() -> Unit): GetNatGatewayResult

Return

A collection of values returned by getNatGateway.

Parameters

argument

Builder for com.pulumi.aws.ec2.kotlin.inputs.GetNatGatewayPlainArgs.

See also

.