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/v2/go/aws/ec2"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        opt0 := localGatewayId
        _, err := ec2.GetLocalGateway(ctx, &ec2.GetLocalGatewayArgs{
            Id: &opt0,
        }, nil)
        if err != nil {
            return err
        }
        return nil
    })
}

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.require("localGatewayId");

const selected = pulumi.output(aws.ec2.getLocalGateway({
    id: localGatewayId,
}, { async: true }));

Using GetLocalGateway

function getLocalGateway(args: GetLocalGatewayArgs, opts?: InvokeOptions): Promise<GetLocalGatewayResult>

function  get_local_gateway(filters=None, id=None, state=None, tags=None, opts=None)

func GetLocalGateway(ctx *Context, args *GetLocalGatewayArgs, opts ...InvokeOption) (*GetLocalGatewayResult, error)

public static class GetLocalGateway {
    public static Task<GetLocalGatewayResult> InvokeAsync(GetLocalGatewayArgs args, InvokeOptions? opts = null)
}

The following arguments are supported:

Filters List<GetLocalGatewayFilterArgs>: 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 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 List[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 Dict[str, str]: 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<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 {[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 Dict[str, str]
filters List[GetLocalGatewayFilter]

Supporting Types

GetLocalGatewayFilter

See the input and output API doc for this type.

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 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 List[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.

Package Details

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

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

GetLocalGateway

Example Usage

Using GetLocalGateway

GetLocalGateway Result

Supporting Types

GetLocalGatewayFilter

Package Details

On This Page