AWS Classic
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/v5/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")
_, err := ec2.LookupNatGateway(ctx, &ec2.LookupNatGatewayArgs{
SubnetId: pulumi.StringRef(aws_subnet.Public.Id),
}, nil)
if err != nil {
return err
}
return nil
})
}
package generated_program;
import java.util.*;
import java.io.*;
import java.nio.*;
import com.pulumi.*;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var config = Config.of();
final var subnetId = config.get("subnetId");
final var default = Output.of(Ec2Functions.getNatGateway(GetNatGatewayArgs.builder()
.subnetId(aws_subnet.getPublic().getId())
.build()));
}
}
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,
});
configuration:
subnetId:
type: dynamic
variables:
default:
Fn::Invoke:
Function: aws:ec2:getNatGateway
Arguments:
subnetId: ${aws_subnet.public.id}
Using getNatGateway
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 getNatGateway(args: GetNatGatewayArgs, opts?: InvokeOptions): Promise<GetNatGatewayResult>
function getNatGatewayOutput(args: GetNatGatewayOutputArgs, opts?: InvokeOptions): Output<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
def get_nat_gateway_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNatGatewayFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
subnet_id: Optional[pulumi.Input[str]] = None,
tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
vpc_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewayResult]
func LookupNatGateway(ctx *Context, args *LookupNatGatewayArgs, opts ...InvokeOption) (*LookupNatGatewayResult, error)
func LookupNatGatewayOutput(ctx *Context, args *LookupNatGatewayOutputArgs, opts ...InvokeOption) LookupNatGatewayResultOutput
> Note: This function is named LookupNatGateway
in the Go SDK.
public static class GetNatGateway
{
public static Task<GetNatGatewayResult> InvokeAsync(GetNatGatewayArgs args, InvokeOptions? opts = null)
public static Output<GetNatGatewayResult> Invoke(GetNatGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNatGatewayResult> getNatGateway(GetNatGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: aws:ec2/getNatGateway:getNatGateway
Arguments:
# Arguments dictionary
The following arguments are supported:
- Filters
List<Pulumi.
Aws. Ec2. Inputs. Get Nat Gateway Filter> 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 ).
- Subnet
Id string The id of subnet that the Nat Gateway resides in.
- Dictionary<string, string>
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
- Vpc
Id string The id of the VPC that the Nat Gateway resides in.
- Filters
[]Get
Nat Gateway Filter 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 ).
- Subnet
Id string The id of subnet that the Nat Gateway resides in.
- map[string]string
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
- Vpc
Id string The id of the VPC that the Nat Gateway resides in.
- filters
List
Nat Gateway Filter> 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 ).
- subnet
Id String The id of subnet that the Nat Gateway resides in.
- Map
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
- vpc
Id String The id of the VPC that the Nat Gateway resides in.
- filters
Get
Nat Gateway Filter[] 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 ).
- subnet
Id string The id of subnet that the Nat Gateway resides in.
- {[key: string]: string}
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
- vpc
Id string The id of the VPC that the Nat Gateway resides in.
- filters
Sequence[Get
Nat Gateway Filter] 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.
- 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.
- filters
List
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 ).
- subnet
Id String The id of subnet that the Nat Gateway resides in.
- Map
A map of tags, each pair of which must exactly match a pair on the desired Nat Gateway.
- vpc
Id String The id of the VPC that the Nat Gateway resides in.
getNatGateway Result
The following output properties are available:
- Allocation
Id string The Id of the EIP allocated to the selected Nat Gateway.
- Connectivity
Type string The connectivity type of the NAT Gateway.
- Id string
- Network
Interface stringId The Id of the ENI allocated to the selected Nat Gateway.
- Private
Ip string The private Ip address of the selected Nat Gateway.
- Public
Ip string The public Ip (EIP) address of the selected Nat Gateway.
- State string
- Subnet
Id string - Dictionary<string, string>
- Vpc
Id string - Filters
List<Pulumi.
Aws. Ec2. Outputs. Get Nat Gateway Filter>
- Allocation
Id string The Id of the EIP allocated to the selected Nat Gateway.
- Connectivity
Type string The connectivity type of the NAT Gateway.
- Id string
- Network
Interface stringId The Id of the ENI allocated to the selected Nat Gateway.
- Private
Ip string The private Ip address of the selected Nat Gateway.
- Public
Ip string The public Ip (EIP) address of the selected Nat Gateway.
- State string
- Subnet
Id string - map[string]string
- Vpc
Id string - Filters
[]Get
Nat Gateway Filter
- allocation
Id String The Id of the EIP allocated to the selected Nat Gateway.
- connectivity
Type String The connectivity type of the NAT Gateway.
- id String
- network
Interface StringId The Id of the ENI allocated to the selected Nat Gateway.
- private
Ip String The private Ip address of the selected Nat Gateway.
- public
Ip String The public Ip (EIP) address of the selected Nat Gateway.
- state String
- subnet
Id String - Map
- vpc
Id String - filters
List
Nat Gateway Filter>
- allocation
Id string The Id of the EIP allocated to the selected Nat Gateway.
- connectivity
Type string The connectivity type of the NAT Gateway.
- id string
- network
Interface stringId The Id of the ENI allocated to the selected Nat Gateway.
- private
Ip string The private Ip address of the selected Nat Gateway.
- public
Ip string The public Ip (EIP) address of the selected Nat Gateway.
- state string
- subnet
Id string - {[key: string]: string}
- vpc
Id string - filters
Get
Nat Gateway Filter[]
- allocation_
id str The Id of the EIP allocated to the selected Nat Gateway.
- connectivity_
type str The connectivity type of the NAT Gateway.
- id str
- network_
interface_ strid 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 - Mapping[str, str]
- vpc_
id str - filters
Sequence[Get
Nat Gateway Filter]
- allocation
Id String The Id of the EIP allocated to the selected Nat Gateway.
- connectivity
Type String The connectivity type of the NAT Gateway.
- id String
- network
Interface StringId The Id of the ENI allocated to the selected Nat Gateway.
- private
Ip String The private Ip address of the selected Nat Gateway.
- public
Ip String The public Ip (EIP) address of the selected Nat Gateway.
- state String
- subnet
Id String - Map
- vpc
Id String - filters
List
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
List
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.
- name String
The name of the field to filter by, as defined by the underlying AWS API.
- values
List
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.