aws.ec2.getLocalGateways

Explore with Pulumi AI

AWS v6.78.0 published on Thursday, Apr 24, 2025 by Pulumi

Example Usage

The following example retrieves Local Gateways with a resource tag of service set to production.

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

export = async () => {
    const foo = await aws.ec2.getLocalGateways({
        tags: {
            service: "production",
        },
    });
    return {
        foo: foo.ids,
    };
}

import pulumi
import pulumi_aws as aws

foo = aws.ec2.get_local_gateways(tags={
    "service": "production",
})
pulumi.export("foo", foo.ids)

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 {
		foo, err := ec2.GetLocalGateways(ctx, &ec2.GetLocalGatewaysArgs{
			Tags: map[string]interface{}{
				"service": "production",
			},
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("foo", foo.Ids)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var foo = Aws.Ec2.GetLocalGateways.Invoke(new()
    {
        Tags = 
        {
            { "service", "production" },
        },
    });

    return new Dictionary<string, object?>
    {
        ["foo"] = foo.Apply(getLocalGatewaysResult => getLocalGatewaysResult.Ids),
    };
});

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.GetLocalGatewaysArgs;
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 foo = Ec2Functions.getLocalGateways(GetLocalGatewaysArgs.builder()
            .tags(Map.of("service", "production"))
            .build());

        ctx.export("foo", foo.ids());
    }
}

variables:
  foo:
    fn::invoke:
      function: aws:ec2:getLocalGateways
      arguments:
        tags:
          service: production
outputs:
  foo: ${foo.ids}

Using getLocalGateways

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.

TypeScript
Python
Go
C#
Java
YAML

function getLocalGateways(args: GetLocalGatewaysArgs, opts?: InvokeOptions): Promise<GetLocalGatewaysResult>
function getLocalGatewaysOutput(args: GetLocalGatewaysOutputArgs, opts?: InvokeOptions): Output<GetLocalGatewaysResult>

def get_local_gateways(filters: Optional[Sequence[GetLocalGatewaysFilter]] = None,
                       tags: Optional[Mapping[str, str]] = None,
                       opts: Optional[InvokeOptions] = None) -> GetLocalGatewaysResult
def get_local_gateways_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLocalGatewaysFilterArgs]]]] = None,
                       tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetLocalGatewaysResult]

func GetLocalGateways(ctx *Context, args *GetLocalGatewaysArgs, opts ...InvokeOption) (*GetLocalGatewaysResult, error)
func GetLocalGatewaysOutput(ctx *Context, args *GetLocalGatewaysOutputArgs, opts ...InvokeOption) GetLocalGatewaysResultOutput

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

public static class GetLocalGateways 
{
    public static Task<GetLocalGatewaysResult> InvokeAsync(GetLocalGatewaysArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalGatewaysResult> Invoke(GetLocalGatewaysInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetLocalGatewaysResult> getLocalGateways(GetLocalGatewaysArgs args, InvokeOptions options)
public static Output<GetLocalGatewaysResult> getLocalGateways(GetLocalGatewaysArgs args, InvokeOptions options)

fn::invoke:
  function: aws:ec2/getLocalGateways:getLocalGateways
  arguments:
    # arguments dictionary

The following arguments are supported:

Filters List<GetLocalGatewaysFilter>