Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. ec2
  5. getLocalGatewayRouteTable
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

aws.ec2.getLocalGatewayRouteTable

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws

Provides details about an EC2 Local Gateway Route Table.

This data source can prove useful when a module accepts a local gateway route table id as an input variable and needs to, for example, find the associated Outpost or Local Gateway.

Example Usage

The following example returns a specific local gateway route table ID

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

const config = new pulumi.Config();
const awsEc2LocalGatewayRouteTable = config.requireObject("awsEc2LocalGatewayRouteTable");
const selected = aws.ec2.getLocalGatewayRouteTable({
    localGatewayRouteTableId: awsEc2LocalGatewayRouteTable,
});
Copy
import pulumi
import pulumi_aws as aws

config = pulumi.Config()
aws_ec2_local_gateway_route_table = config.require_object("awsEc2LocalGatewayRouteTable")
selected = aws.ec2.get_local_gateway_route_table(local_gateway_route_table_id=aws_ec2_local_gateway_route_table)
Copy
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v6/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, "")
		awsEc2LocalGatewayRouteTable := cfg.RequireObject("awsEc2LocalGatewayRouteTable")
		_, err := ec2.GetLocalGatewayRouteTable(ctx, &ec2.GetLocalGatewayRouteTableArgs{
			LocalGatewayRouteTableId: pulumi.StringRef(awsEc2LocalGatewayRouteTable),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var config = new Config();
    var awsEc2LocalGatewayRouteTable = config.RequireObject<dynamic>("awsEc2LocalGatewayRouteTable");
    var selected = Aws.Ec2.GetLocalGatewayRouteTable.Invoke(new()
    {
        LocalGatewayRouteTableId = awsEc2LocalGatewayRouteTable,
    });

});
Copy
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.GetLocalGatewayRouteTableArgs;
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 config = ctx.config();
        final var awsEc2LocalGatewayRouteTable = config.get("awsEc2LocalGatewayRouteTable");
        final var selected = Ec2Functions.getLocalGatewayRouteTable(GetLocalGatewayRouteTableArgs.builder()
            .localGatewayRouteTableId(awsEc2LocalGatewayRouteTable)
            .build());

    }
}
Copy
configuration:
  awsEc2LocalGatewayRouteTable:
    type: dynamic
variables:
  selected:
    fn::invoke:
      function: aws:ec2:getLocalGatewayRouteTable
      arguments:
        localGatewayRouteTableId: ${awsEc2LocalGatewayRouteTable}
Copy

Using getLocalGatewayRouteTable

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 getLocalGatewayRouteTable(args: GetLocalGatewayRouteTableArgs, opts?: InvokeOptions): Promise<GetLocalGatewayRouteTableResult>
function getLocalGatewayRouteTableOutput(args: GetLocalGatewayRouteTableOutputArgs, opts?: InvokeOptions): Output<GetLocalGatewayRouteTableResult>
Copy
def get_local_gateway_route_table(filters: Optional[Sequence[GetLocalGatewayRouteTableFilter]] = None,
                                  local_gateway_id: Optional[str] = None,
                                  local_gateway_route_table_id: Optional[str] = None,
                                  outpost_arn: Optional[str] = None,
                                  state: Optional[str] = None,
                                  tags: Optional[Mapping[str, str]] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetLocalGatewayRouteTableResult
def get_local_gateway_route_table_output(filters: Optional[pulumi.Input[Sequence[pulumi.Input[GetLocalGatewayRouteTableFilterArgs]]]] = None,
                                  local_gateway_id: Optional[pulumi.Input[str]] = None,
                                  local_gateway_route_table_id: Optional[pulumi.Input[str]] = None,
                                  outpost_arn: 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[GetLocalGatewayRouteTableResult]
Copy
func GetLocalGatewayRouteTable(ctx *Context, args *GetLocalGatewayRouteTableArgs, opts ...InvokeOption) (*GetLocalGatewayRouteTableResult, error)
func GetLocalGatewayRouteTableOutput(ctx *Context, args *GetLocalGatewayRouteTableOutputArgs, opts ...InvokeOption) GetLocalGatewayRouteTableResultOutput
Copy

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

public static class GetLocalGatewayRouteTable 
{
    public static Task<GetLocalGatewayRouteTableResult> InvokeAsync(GetLocalGatewayRouteTableArgs args, InvokeOptions? opts = null)
    public static Output<GetLocalGatewayRouteTableResult> Invoke(GetLocalGatewayRouteTableInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetLocalGatewayRouteTableResult> getLocalGatewayRouteTable(GetLocalGatewayRouteTableArgs args, InvokeOptions options)
public static Output<GetLocalGatewayRouteTableResult> getLocalGatewayRouteTable(GetLocalGatewayRouteTableArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: aws:ec2/getLocalGatewayRouteTable:getLocalGatewayRouteTable
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Filters List<GetLocalGatewayRouteTableFilter>
LocalGatewayId string
ID of the specific local gateway route table to retrieve.
LocalGatewayRouteTableId string
Local Gateway Route Table Id assigned to desired local gateway route table
OutpostArn string
ARN of the Outpost the local gateway route table is associated with.
State string
State of the local gateway route table.
Tags Dictionary<string, string>

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

Filters []GetLocalGatewayRouteTableFilter
LocalGatewayId string
ID of the specific local gateway route table to retrieve.
LocalGatewayRouteTableId string
Local Gateway Route Table Id assigned to desired local gateway route table
OutpostArn string
ARN of the Outpost the local gateway route table is associated with.
State string
State of the local gateway route table.
Tags map[string]string

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

filters List<GetLocalGatewayRouteTableFilter>
localGatewayId String
ID of the specific local gateway route table to retrieve.
localGatewayRouteTableId String
Local Gateway Route Table Id assigned to desired local gateway route table
outpostArn String
ARN of the Outpost the local gateway route table is associated with.
state String
State of the local gateway route table.
tags Map<String,String>

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

filters GetLocalGatewayRouteTableFilter[]
localGatewayId string
ID of the specific local gateway route table to retrieve.
localGatewayRouteTableId string
Local Gateway Route Table Id assigned to desired local gateway route table
outpostArn string
ARN of the Outpost the local gateway route table is associated with.
state string
State of the local gateway route table.
tags {[key: string]: string}

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

filters Sequence[GetLocalGatewayRouteTableFilter]
local_gateway_id str
ID of the specific local gateway route table to retrieve.
local_gateway_route_table_id str
Local Gateway Route Table Id assigned to desired local gateway route table
outpost_arn str
ARN of the Outpost the local gateway route table is associated with.
state str
State of the local gateway route table.
tags Mapping[str, str]

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

filters List<Property Map>
localGatewayId String
ID of the specific local gateway route table to retrieve.
localGatewayRouteTableId String
Local Gateway Route Table Id assigned to desired local gateway route table
outpostArn String
ARN of the Outpost the local gateway route table is associated with.
state String
State of the local gateway route table.
tags Map<String>

Mapping of tags, each pair of which must exactly match a pair on the desired local gateway route table.

More complex filters can be expressed using one or more filter sub-blocks, which take the following arguments:

getLocalGatewayRouteTable Result

The following output properties are available:

Id string
The provider-assigned unique ID for this managed resource.
LocalGatewayId string
LocalGatewayRouteTableId string
OutpostArn string
State string
Tags Dictionary<string, string>
Filters List<GetLocalGatewayRouteTableFilter>
Id string
The provider-assigned unique ID for this managed resource.
LocalGatewayId string
LocalGatewayRouteTableId string
OutpostArn string
State string
Tags map[string]string
Filters []GetLocalGatewayRouteTableFilter
id String
The provider-assigned unique ID for this managed resource.
localGatewayId String
localGatewayRouteTableId String
outpostArn String
state String
tags Map<String,String>
filters List<GetLocalGatewayRouteTableFilter>
id string
The provider-assigned unique ID for this managed resource.
localGatewayId string
localGatewayRouteTableId string
outpostArn string
state string
tags {[key: string]: string}
filters GetLocalGatewayRouteTableFilter[]
id str
The provider-assigned unique ID for this managed resource.
local_gateway_id str
local_gateway_route_table_id str
outpost_arn str
state str
tags Mapping[str, str]
filters Sequence[GetLocalGatewayRouteTableFilter]
id String
The provider-assigned unique ID for this managed resource.
localGatewayId String
localGatewayRouteTableId String
outpostArn String
state String
tags Map<String>
filters List<Property Map>

Supporting Types

GetLocalGatewayRouteTableFilter

Name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
Values This property is required. List<string>
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.
Name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
Values This property is required. []string
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.
name This property is required. String
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. List<String>
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.
name This property is required. string
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. string[]
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.
name This property is required. str
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. Sequence[str]
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.
name This property is required. String
Name of the field to filter by, as defined by the underlying AWS API.
values This property is required. List<String>
Set of values that are accepted for the given field. A local gateway route table will be selected if any one of the given values matches.

Package Details

Repository
AWS Classic pulumi/pulumi-aws
License
Apache-2.0
Notes
This Pulumi package is based on the aws Terraform Provider.
AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-aws