AWS Classic

Pulumi Official
Package maintained by Pulumi
v5.4.0 published on Wednesday, May 4, 2022 by Pulumi

getLocalGateway

Provides details about an EC2 Local Gateway.

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var config = new Config();
        var localGatewayId = config.RequireObject<dynamic>("localGatewayId");
        var selected = Output.Create(Aws.Ec2.GetLocalGateway.InvokeAsync(new Aws.Ec2.GetLocalGatewayArgs
        {
            Id = localGatewayId,
        }));
    }

}
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, "")
		localGatewayId := cfg.RequireObject("localGatewayId")
		_, err := ec2.GetLocalGateway(ctx, &ec2.GetLocalGatewayArgs{
			Id: pulumi.StringRef(localGatewayId),
		}, 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 localGatewayId = config.get("localGatewayId");
        final var selected = Output.of(Ec2Functions.getLocalGateway(GetLocalGatewayArgs.builder()
            .id(localGatewayId)
            .build()));

        }
}
import pulumi
import pulumi_aws as aws

config = pulumi.Config()
local_gateway_id = config.require_object("localGatewayId")
selected = aws.ec2.get_local_gateway(id=local_gateway_id)
import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const config = new pulumi.Config();
const localGatewayId = config.requireObject("localGatewayId");
const selected = aws.ec2.getLocalGateway({
    id: localGatewayId,
});
configuration:
  localGatewayId:
    type: dynamic
variables:
  selected:
    Fn::Invoke:
      Function: aws:ec2:getLocalGateway
      Arguments:
        id: ${localGatewayId}

Using getLocalGateway

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 getLocalGateway(args: GetLocalGatewayArgs, opts?: InvokeOptions): Promise<GetLocalGatewayResult>
function getLocalGatewayOutput(args: GetLocalGatewayOutputArgs, opts?: InvokeOptions): Output<GetLocalGatewayResult>
def get_local_gateway(filters: Optional[Sequence[GetLocalGatewayFilter]] = None,
                      id: Optional[str] = None,
                      state: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      opts: Optional[InvokeOptions] = None) -> GetLocalGatewayResult
def get_local_gateway_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLocalGatewayFilterArgs]]]] = None,
                      id: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetLocalGatewayResult]
func GetLocalGateway(ctx *Context, args *GetLocalGatewayArgs, opts ...InvokeOption) (*GetLocalGatewayResult, error)
func GetLocalGatewayOutput(ctx *Context, args *GetLocalGatewayOutputArgs, opts ...InvokeOption) GetLocalGatewayResultOutput

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

public static class GetLocalGateway 
{
    public static Task<GetLocalGatewayResult> InvokeAsync(GetLocalGatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalGatewayResult> Invoke(GetLocalGatewayInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetLocalGatewayResult> getLocalGateway(GetLocalGatewayArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: aws:ec2/getLocalGateway:getLocalGateway
  Arguments:
    # Arguments dictionary

The following arguments are supported:

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

Custom filter block as described below.

Id string

The id of the specific Local Gateway to retrieve.

State string

The current state of the desired Local Gateway. Can be either "pending" or "available".

Tags Dictionary<string, string>

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

Filters []GetLocalGatewayFilter

Custom filter block as described below.

Id string

The id of the specific Local Gateway to retrieve.

State string

The current state of the desired Local Gateway. Can be either "pending" or "available".

Tags map[string]string

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

filters ListLocalGatewayFilter>

Custom filter block as described below.

id String

The id of the specific Local Gateway to retrieve.

state String

The current state of the desired Local Gateway. Can be either "pending" or "available".

tags Map

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

filters GetLocalGatewayFilter[]

Custom filter block as described below.

id string

The id of the specific Local Gateway to retrieve.

state string

The current state of the desired Local Gateway. Can be either "pending" or "available".

tags {[key: string]: string}

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

filters Sequence[GetLocalGatewayFilter]

Custom filter block as described below.

id str

The id of the specific Local Gateway to retrieve.

state str

The current state of the desired Local Gateway. Can be either "pending" or "available".

tags Mapping[str, str]

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

filters List

Custom filter block as described below.

id String

The id of the specific Local Gateway to retrieve.

state String

The current state of the desired Local Gateway. Can be either "pending" or "available".

tags Map

A mapping of tags, each pair of which must exactly match a pair on the desired Local Gateway.

getLocalGateway Result

The following output properties are available:

Id string
OutpostArn string

Amazon Resource Name (ARN) of Outpost

OwnerId string

AWS account identifier that owns the Local Gateway.

State string

State of the local gateway.

Tags Dictionary<string, string>
Filters List<Pulumi.Aws.Ec2.Outputs.GetLocalGatewayFilter>
Id string
OutpostArn string

Amazon Resource Name (ARN) of Outpost

OwnerId string

AWS account identifier that owns the Local Gateway.

State string

State of the local gateway.

Tags map[string]string
Filters []GetLocalGatewayFilter
id String
outpostArn String

Amazon Resource Name (ARN) of Outpost

ownerId String

AWS account identifier that owns the Local Gateway.

state String

State of the local gateway.

tags Map
filters ListLocalGatewayFilter>
id string
outpostArn string

Amazon Resource Name (ARN) of Outpost

ownerId string

AWS account identifier that owns the Local Gateway.

state string

State of the local gateway.

tags {[key: string]: string}
filters GetLocalGatewayFilter[]
id str
outpost_arn str

Amazon Resource Name (ARN) of Outpost

owner_id str

AWS account identifier that owns the Local Gateway.

state str

State of the local gateway.

tags Mapping[str, str]
filters Sequence[GetLocalGatewayFilter]
id String
outpostArn String

Amazon Resource Name (ARN) of Outpost

ownerId String

AWS account identifier that owns the Local Gateway.

state String

State of the local gateway.

tags Map
filters List

Supporting Types

GetLocalGatewayFilter

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