AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.11.0 published on Wednesday, Aug 17, 2022 by Pulumi

getNatGateways

This resource can be useful for getting back a list of NAT gateway ids to be referenced elsewhere.

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>
def get_nat_gateways(filters: Optional[Sequence[GetNatGatewaysFilter]] = None,
                     tags: Optional[Mapping[str, str]] = None,
                     vpc_id: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetNatGatewaysResult
def get_nat_gateways_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetNatGatewaysFilterArgs]]]] = None,
                     tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                     vpc_id: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetNatGatewaysResult]
func GetNatGateways(ctx *Context, args *GetNatGatewaysArgs, opts ...InvokeOption) (*GetNatGatewaysResult, error)
func GetNatGatewaysOutput(ctx *Context, args *GetNatGatewaysOutputArgs, opts ...InvokeOption) GetNatGatewaysResultOutput

> 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)
}
public static CompletableFuture<GetNatGatewaysResult> getNatGateways(GetNatGatewaysArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:ec2/getNatGateways:getNatGateways
  Arguments:
    # Arguments dictionary

The following arguments are supported:

Filters List<Pulumi.Aws.Ec2.Inputs.GetNatGatewaysFilter>

Custom filter block as described below.

Tags Dictionary<string, string>

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

VpcId string

The VPC ID that you want to filter from.

Filters []GetNatGatewaysFilter

Custom filter block as described below.

Tags map[string]string

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

VpcId string

The VPC ID that you want to filter from.

filters List<GetNatGatewaysFilter>

Custom filter block as described below.

tags Map<String,String>

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

vpcId String

The VPC ID that you want to filter from.

filters GetNatGatewaysFilter[]

Custom filter block as described below.

tags {[key: string]: string}

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

vpcId string

The VPC ID that you want to filter from.

filters Sequence[GetNatGatewaysFilter]

Custom filter block as described below.

tags Mapping[str, str]

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

vpc_id str

The VPC ID that you want to filter from.

filters List<Property Map>

Custom filter block as described below.

tags Map<String>

A map of tags, each pair of which must exactly match a pair on the desired NAT Gateways.

vpcId String

The VPC ID that you want to filter from.

getNatGateways Result

The following output properties are available:

Id string

The provider-assigned unique ID for this managed resource.

Ids List<string>

A list of all the NAT gateway ids found.

Tags Dictionary<string, string>
Filters List<Pulumi.Aws.Ec2.Outputs.GetNatGatewaysFilter>
VpcId string
Id string

The provider-assigned unique ID for this managed resource.

Ids []string

A list of all the NAT gateway ids found.

Tags map[string]string
Filters []GetNatGatewaysFilter
VpcId string
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of all the NAT gateway ids found.

tags Map<String,String>
filters List<GetNatGatewaysFilter>
vpcId String
id string

The provider-assigned unique ID for this managed resource.

ids string[]

A list of all the NAT gateway ids found.

tags {[key: string]: string}
filters GetNatGatewaysFilter[]
vpcId string
id str

The provider-assigned unique ID for this managed resource.

ids Sequence[str]

A list of all the NAT gateway ids found.

tags Mapping[str, str]
filters Sequence[GetNatGatewaysFilter]
vpc_id str
id String

The provider-assigned unique ID for this managed resource.

ids List<String>

A list of all the NAT gateway ids found.

tags Map<String>
filters List<Property Map>
vpcId String

Supporting Types

GetNatGatewaysFilter

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. A 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. A 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<String>

Set of values that are accepted for the given field. A 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. A 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. A 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<String>

Set of values that are accepted for the given field. A 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.