1. Packages
  2. DigitalOcean Provider
  3. API Docs
  4. getVpcNatGateway
DigitalOcean v4.47.0 published on Tuesday, Jun 10, 2025 by Pulumi

digitalocean.getVpcNatGateway

Explore with Pulumi AI

digitalocean logo
DigitalOcean v4.47.0 published on Tuesday, Jun 10, 2025 by Pulumi

    Example Usage

    Get the VPC NAT Gateway by name:

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const my_imported_vpc_nat_gateway = digitalocean.getVpcNatGateway({
        name: my_existing_vpc_nat_gateway.name,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    my_imported_vpc_nat_gateway = digitalocean.get_vpc_nat_gateway(name=my_existing_vpc_nat_gateway["name"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := digitalocean.LookupVpcNatGateway(ctx, &digitalocean.LookupVpcNatGatewayArgs{
    			Name: pulumi.StringRef(my_existing_vpc_nat_gateway.Name),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var my_imported_vpc_nat_gateway = DigitalOcean.GetVpcNatGateway.Invoke(new()
        {
            Name = my_existing_vpc_nat_gateway.Name,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetVpcNatGatewayArgs;
    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 my-imported-vpc-nat-gateway = DigitaloceanFunctions.getVpcNatGateway(GetVpcNatGatewayArgs.builder()
                .name(my_existing_vpc_nat_gateway.name())
                .build());
    
        }
    }
    
    variables:
      my-imported-vpc-nat-gateway:
        fn::invoke:
          function: digitalocean:getVpcNatGateway
          arguments:
            name: ${["my-existing-vpc-nat-gateway"].name}
    

    Get the VPC NAT Gateway by ID:

    import * as pulumi from "@pulumi/pulumi";
    import * as digitalocean from "@pulumi/digitalocean";
    
    const my_imported_vpc_nat_gateway = digitalocean.getVpcNatGateway({
        id: my_existing_vpc_nat_gateway.id,
    });
    
    import pulumi
    import pulumi_digitalocean as digitalocean
    
    my_imported_vpc_nat_gateway = digitalocean.get_vpc_nat_gateway(id=my_existing_vpc_nat_gateway["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-digitalocean/sdk/v4/go/digitalocean"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := digitalocean.LookupVpcNatGateway(ctx, &digitalocean.LookupVpcNatGatewayArgs{
    			Id: pulumi.StringRef(my_existing_vpc_nat_gateway.Id),
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using DigitalOcean = Pulumi.DigitalOcean;
    
    return await Deployment.RunAsync(() => 
    {
        var my_imported_vpc_nat_gateway = DigitalOcean.GetVpcNatGateway.Invoke(new()
        {
            Id = my_existing_vpc_nat_gateway.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.digitalocean.DigitaloceanFunctions;
    import com.pulumi.digitalocean.inputs.GetVpcNatGatewayArgs;
    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 my-imported-vpc-nat-gateway = DigitaloceanFunctions.getVpcNatGateway(GetVpcNatGatewayArgs.builder()
                .id(my_existing_vpc_nat_gateway.id())
                .build());
    
        }
    }
    
    variables:
      my-imported-vpc-nat-gateway:
        fn::invoke:
          function: digitalocean:getVpcNatGateway
          arguments:
            id: ${["my-existing-vpc-nat-gateway"].id}
    

    Using getVpcNatGateway

    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 getVpcNatGateway(args: GetVpcNatGatewayArgs, opts?: InvokeOptions): Promise<GetVpcNatGatewayResult>
    function getVpcNatGatewayOutput(args: GetVpcNatGatewayOutputArgs, opts?: InvokeOptions): Output<GetVpcNatGatewayResult>
    def get_vpc_nat_gateway(id: Optional[str] = None,
                            name: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetVpcNatGatewayResult
    def get_vpc_nat_gateway_output(id: Optional[pulumi.Input[str]] = None,
                            name: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetVpcNatGatewayResult]
    func LookupVpcNatGateway(ctx *Context, args *LookupVpcNatGatewayArgs, opts ...InvokeOption) (*LookupVpcNatGatewayResult, error)
    func LookupVpcNatGatewayOutput(ctx *Context, args *LookupVpcNatGatewayOutputArgs, opts ...InvokeOption) LookupVpcNatGatewayResultOutput

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

    public static class GetVpcNatGateway 
    {
        public static Task<GetVpcNatGatewayResult> InvokeAsync(GetVpcNatGatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetVpcNatGatewayResult> Invoke(GetVpcNatGatewayInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetVpcNatGatewayResult> getVpcNatGateway(GetVpcNatGatewayArgs args, InvokeOptions options)
    public static Output<GetVpcNatGatewayResult> getVpcNatGateway(GetVpcNatGatewayArgs args, InvokeOptions options)
    
    fn::invoke:
      function: digitalocean:index/getVpcNatGateway:getVpcNatGateway
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Id string
    The ID of VPC NAT Gateway.
    Name string
    The name of VPC NAT Gateway.
    Id string
    The ID of VPC NAT Gateway.
    Name string
    The name of VPC NAT Gateway.
    id String
    The ID of VPC NAT Gateway.
    name String
    The name of VPC NAT Gateway.
    id string
    The ID of VPC NAT Gateway.
    name string
    The name of VPC NAT Gateway.
    id str
    The ID of VPC NAT Gateway.
    name str
    The name of VPC NAT Gateway.
    id String
    The ID of VPC NAT Gateway.
    name String
    The name of VPC NAT Gateway.

    getVpcNatGateway Result

    The following output properties are available:

    Supporting Types

    GetVpcNatGatewayEgress

    publicGateways List<Property Map>
    List of public gateway IPs

    GetVpcNatGatewayEgressPublicGateway

    Ipv4 string
    IPv4 address
    Ipv4 string
    IPv4 address
    ipv4 String
    IPv4 address
    ipv4 string
    IPv4 address
    ipv4 str
    IPv4 address
    ipv4 String
    IPv4 address

    GetVpcNatGatewayVpc

    DefaultGateway bool
    Indicates if this is the default VPC NAT Gateway in the VPC
    GatewayIp string
    Gateway IP of the VPC NAT Gateway
    VpcUuid string
    ID of the ingress VPC
    DefaultGateway bool
    Indicates if this is the default VPC NAT Gateway in the VPC
    GatewayIp string
    Gateway IP of the VPC NAT Gateway
    VpcUuid string
    ID of the ingress VPC
    defaultGateway Boolean
    Indicates if this is the default VPC NAT Gateway in the VPC
    gatewayIp String
    Gateway IP of the VPC NAT Gateway
    vpcUuid String
    ID of the ingress VPC
    defaultGateway boolean
    Indicates if this is the default VPC NAT Gateway in the VPC
    gatewayIp string
    Gateway IP of the VPC NAT Gateway
    vpcUuid string
    ID of the ingress VPC
    default_gateway bool
    Indicates if this is the default VPC NAT Gateway in the VPC
    gateway_ip str
    Gateway IP of the VPC NAT Gateway
    vpc_uuid str
    ID of the ingress VPC
    defaultGateway Boolean
    Indicates if this is the default VPC NAT Gateway in the VPC
    gatewayIp String
    Gateway IP of the VPC NAT Gateway
    vpcUuid String
    ID of the ingress VPC

    Package Details

    Repository
    DigitalOcean pulumi/pulumi-digitalocean
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the digitalocean Terraform Provider.
    digitalocean logo
    DigitalOcean v4.47.0 published on Tuesday, Jun 10, 2025 by Pulumi