getNatGateway

Provides details about a specific Nat Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var subnetId = config.RequireObject<dynamic>("subnetId");
        var @default = Output.Create(Aws.Ec2.GetNatGateway.InvokeAsync(new Aws.Ec2.GetNatGatewayArgs
        {
            SubnetId = aws_subnet.Public.Id,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v4/go/aws/ec2"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		cfg := config.New(ctx, "")
		subnetId := cfg.RequireObject("subnetId")
		opt0 := aws_subnet.Public.Id
		_, err := ec2.LookupNatGateway(ctx, &ec2.LookupNatGatewayArgs{
			SubnetId: &opt0,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
import pulumi
import pulumi_aws as aws

config = pulumi.Config()
subnet_id = config.require_object("subnetId")
default = aws.ec2.get_nat_gateway(subnet_id=aws_subnet["public"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const subnetId = config.requireObject("subnetId");
const default = aws.ec2.getNatGateway({
    subnetId: aws_subnet["public"].id,
});

Using getNatGateway

function getNatGateway(args: GetNatGatewayArgs, opts?: InvokeOptions): Promise<GetNatGatewayResult>
def get_nat_gateway(filters: Optional[Sequence[GetNatGatewayFilter]] = None,
                    id: Optional[str] = None,
                    state: Optional[str] = None,
                    subnet_id: Optional[str] = None,
                    tags: Optional[Mapping[str, str]] = None,
                    vpc_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetNatGatewayResult
func LookupNatGateway(ctx *Context, args *LookupNatGatewayArgs, opts ...InvokeOption) (*LookupNatGatewayResult, error)

Note: This function is named LookupNatGateway in the Go SDK.

public static class GetNatGateway {
    public static Task<GetNatGatewayResult> InvokeAsync(GetNatGatewayArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<GetNatGatewayFilter>
Custom filter block as described below.
Id string
The id of the specific Nat Gateway to retrieve.
State string
The state of the NAT gateway (pending | failed | available | deleting | deleted ).
SubnetId string
The id of subnet that the Nat Gateway resides in.
Tags Dictionary<string, string>
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
VpcId string
The id of the VPC that the Nat Gateway resides in.
Filters []GetNatGatewayFilter
Custom filter block as described below.
Id string
The id of the specific Nat Gateway to retrieve.
State string
The state of the NAT gateway (pending | failed | available | deleting | deleted ).
SubnetId string
The id of subnet that the Nat Gateway resides in.
Tags map[string]string
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
VpcId string
The id of the VPC that the Nat Gateway resides in.
filters GetNatGatewayFilter[]
Custom filter block as described below.
id string
The id of the specific Nat Gateway to retrieve.
state string
The state of the NAT gateway (pending | failed | available | deleting | deleted ).
subnetId string
The id of subnet that the Nat Gateway resides in.
tags {[key: string]: string}
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
vpcId string
The id of the VPC that the Nat Gateway resides in.
filters Sequence[GetNatGatewayFilter]
Custom filter block as described below.
id str
The id of the specific Nat Gateway to retrieve.
state str
The state of the NAT gateway (pending | failed | available | deleting | deleted ).
subnet_id str
The id of subnet that the Nat Gateway resides in.
tags Mapping[str, str]
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
vpc_id str
The id of the VPC that the Nat Gateway resides in.

getNatGateway Result

The following output properties are available:

AllocationId string
The Id of the EIP allocated to the selected Nat Gateway.
Id string
NetworkInterfaceId string
The Id of the ENI allocated to the selected Nat Gateway.
PrivateIp string
The private Ip address of the selected Nat Gateway.
PublicIp string
The public Ip (EIP) address of the selected Nat Gateway.
State string
SubnetId string
Tags Dictionary<string, string>
VpcId string
Filters List<GetNatGatewayFilter>
AllocationId string
The Id of the EIP allocated to the selected Nat Gateway.
Id string
NetworkInterfaceId string
The Id of the ENI allocated to the selected Nat Gateway.
PrivateIp string
The private Ip address of the selected Nat Gateway.
PublicIp string
The public Ip (EIP) address of the selected Nat Gateway.
State string
SubnetId string
Tags map[string]string
VpcId string
Filters []GetNatGatewayFilter
allocationId string
The Id of the EIP allocated to the selected Nat Gateway.
id string
networkInterfaceId string
The Id of the ENI allocated to the selected Nat Gateway.
privateIp string
The private Ip address of the selected Nat Gateway.
publicIp string
The public Ip (EIP) address of the selected Nat Gateway.
state string
subnetId string
tags {[key: string]: string}
vpcId string
filters GetNatGatewayFilter[]
allocation_id str
The Id of the EIP allocated to the selected Nat Gateway.
id str
network_interface_id str
The Id of the ENI allocated to the selected Nat Gateway.
private_ip str
The private Ip address of the selected Nat Gateway.
public_ip str
The public Ip (EIP) address of the selected Nat Gateway.
state str
subnet_id str
tags Mapping[str, str]
vpc_id str
filters Sequence[GetNatGatewayFilter]

Supporting Types

GetNatGatewayFilter

Name string
The name of the field to filter by, as defined by the underlying AWS API.
Values List<string>
Set of values that are accepted for the given field. An Nat Gateway will be selected if any one of the given values matches.
Name string
The name of the field to filter by, as defined by the underlying AWS API.
Values []string
Set of values that are accepted for the given field. An Nat Gateway will be selected if any one of the given values matches.
name string
The name of the field to filter by, as defined by the underlying AWS API.
values string[]
Set of values that are accepted for the given field. An Nat Gateway will be selected if any one of the given values matches.
name str
The name of the field to filter by, as defined by the underlying AWS API.
values Sequence[str]
Set of values that are accepted for the given field. An Nat Gateway will be selected if any one of the given values matches.

Package Details

Repository
https://github.com/pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.