aws.appmesh.getGatewayRoute

Start a Neo task

Explain and create an aws.appmesh.getGatewayRoute resource

AWS v7.11.0 published on Wednesday, Nov 5, 2025 by Pulumi

pulumi/pulumi-aws

Example Usage

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

const test = aws.appmesh.getGatewayRoute({
    name: "test-route",
    meshName: "test-mesh",
    virtualGatewayName: "test-gateway",
});

import pulumi
import pulumi_aws as aws

test = aws.appmesh.get_gateway_route(name="test-route",
    mesh_name="test-mesh",
    virtual_gateway_name="test-gateway")

package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/appmesh"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := appmesh.LookupGatewayRoute(ctx, &appmesh.LookupGatewayRouteArgs{
			Name:               "test-route",
			MeshName:           "test-mesh",
			VirtualGatewayName: "test-gateway",
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

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

return await Deployment.RunAsync(() => 
{
    var test = Aws.AppMesh.GetGatewayRoute.Invoke(new()
    {
        Name = "test-route",
        MeshName = "test-mesh",
        VirtualGatewayName = "test-gateway",
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.appmesh.AppmeshFunctions;
import com.pulumi.aws.appmesh.inputs.GetGatewayRouteArgs;
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 test = AppmeshFunctions.getGatewayRoute(GetGatewayRouteArgs.builder()
            .name("test-route")
            .meshName("test-mesh")
            .virtualGatewayName("test-gateway")
            .build());

    }
}

variables:
  test:
    fn::invoke:
      function: aws:appmesh:getGatewayRoute
      arguments:
        name: test-route
        meshName: test-mesh
        virtualGatewayName: test-gateway

Using getGatewayRoute

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 getGatewayRoute(args: GetGatewayRouteArgs, opts?: InvokeOptions): Promise<GetGatewayRouteResult>
function getGatewayRouteOutput(args: GetGatewayRouteOutputArgs, opts?: InvokeOptions): Output<GetGatewayRouteResult>

def get_gateway_route(mesh_name: Optional[str] = None,
                      mesh_owner: Optional[str] = None,
                      name: Optional[str] = None,
                      region: Optional[str] = None,
                      tags: Optional[Mapping[str, str]] = None,
                      virtual_gateway_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetGatewayRouteResult
def get_gateway_route_output(mesh_name: Optional[pulumi.Input[str]] = None,
                      mesh_owner: Optional[pulumi.Input[str]] = None,
                      name: Optional[pulumi.Input[str]] = None,
                      region: Optional[pulumi.Input[str]] = None,
                      tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
                      virtual_gateway_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetGatewayRouteResult]

func LookupGatewayRoute(ctx *Context, args *LookupGatewayRouteArgs, opts ...InvokeOption) (*LookupGatewayRouteResult, error)
func LookupGatewayRouteOutput(ctx *Context, args *LookupGatewayRouteOutputArgs, opts ...InvokeOption) LookupGatewayRouteResultOutput

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

public static class GetGatewayRoute 
{
    public static Task<GetGatewayRouteResult> InvokeAsync(GetGatewayRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayRouteResult> Invoke(GetGatewayRouteInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetGatewayRouteResult> getGatewayRoute(GetGatewayRouteArgs args, InvokeOptions options)
public static Output<GetGatewayRouteResult> getGatewayRoute(GetGatewayRouteArgs args, InvokeOptions options)

fn::invoke:
  function: aws:appmesh/getGatewayRoute:getGatewayRoute
  arguments:
    # arguments dictionary

The following arguments are supported:

MeshName string: Name of the service mesh in which the virtual gateway exists.
Name string: Name of the gateway route.
VirtualGatewayName string: Name of the virtual gateway in which the route exists.
MeshOwner string: AWS account ID of the service mesh's owner.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags Dictionary<string, string>: Map of tags.

MeshName string: Name of the service mesh in which the virtual gateway exists.
Name string: Name of the gateway route.
VirtualGatewayName string: Name of the virtual gateway in which the route exists.
MeshOwner string: AWS account ID of the service mesh's owner.
Region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
Tags map[string]string: Map of tags.

meshName String: Name of the service mesh in which the virtual gateway exists.
name String: Name of the gateway route.
virtualGatewayName String: Name of the virtual gateway in which the route exists.
meshOwner String: AWS account ID of the service mesh's owner.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String,String>: Map of tags.

meshName string: Name of the service mesh in which the virtual gateway exists.
name string: Name of the gateway route.
virtualGatewayName string: Name of the virtual gateway in which the route exists.
meshOwner string: AWS account ID of the service mesh's owner.
region string: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags {[key: string]: string}: Map of tags.

mesh_name str: Name of the service mesh in which the virtual gateway exists.
name str: Name of the gateway route.
virtual_gateway_name str: Name of the virtual gateway in which the route exists.
mesh_owner str: AWS account ID of the service mesh's owner.
region str: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Mapping[str, str]: Map of tags.

meshName String: Name of the service mesh in which the virtual gateway exists.
name String: Name of the gateway route.
virtualGatewayName String: Name of the virtual gateway in which the route exists.
meshOwner String: AWS account ID of the service mesh's owner.
region String: Region where this resource will be managed. Defaults to the Region set in the provider configuration.
tags Map<String>: Map of tags.

getGatewayRoute Result

The following output properties are available:

Arn string: ARN of the gateway route.
CreatedDate string: Creation date of the gateway route.
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedDate string: Last update date of the gateway route.
MeshName string
MeshOwner string
Name string
Region string
ResourceOwner string: Resource owner's AWS account ID.
Specs List<GetGatewayRouteSpec>: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
Tags Dictionary<string, string>: Map of tags.
VirtualGatewayName string

Arn string: ARN of the gateway route.
CreatedDate string: Creation date of the gateway route.
Id string: The provider-assigned unique ID for this managed resource.
LastUpdatedDate string: Last update date of the gateway route.
MeshName string
MeshOwner string
Name string
Region string
ResourceOwner string: Resource owner's AWS account ID.
Specs []GetGatewayRouteSpec: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
Tags map[string]string: Map of tags.
VirtualGatewayName string

arn String: ARN of the gateway route.
createdDate String: Creation date of the gateway route.
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedDate String: Last update date of the gateway route.
meshName String
meshOwner String
name String
region String
resourceOwner String: Resource owner's AWS account ID.
specs List<GetGatewayRouteSpec>: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
tags Map<String,String>: Map of tags.
virtualGatewayName String

arn string: ARN of the gateway route.
createdDate string: Creation date of the gateway route.
id string: The provider-assigned unique ID for this managed resource.
lastUpdatedDate string: Last update date of the gateway route.
meshName string
meshOwner string
name string
region string
resourceOwner string: Resource owner's AWS account ID.
specs GetGatewayRouteSpec[]: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
tags {[key: string]: string}: Map of tags.
virtualGatewayName string

arn str: ARN of the gateway route.
created_date str: Creation date of the gateway route.
id str: The provider-assigned unique ID for this managed resource.
last_updated_date str: Last update date of the gateway route.
mesh_name str
mesh_owner str
name str
region str
resource_owner str: Resource owner's AWS account ID.
specs Sequence[GetGatewayRouteSpec]: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
tags Mapping[str, str]: Map of tags.
virtual_gateway_name str

arn String: ARN of the gateway route.
createdDate String: Creation date of the gateway route.
id String: The provider-assigned unique ID for this managed resource.
lastUpdatedDate String: Last update date of the gateway route.
meshName String
meshOwner String
name String
region String
resourceOwner String: Resource owner's AWS account ID.
specs List<Property Map>: Gateway route specification. See the aws.appmesh.GatewayRoute resource for details.
tags Map<String>: Map of tags.
virtualGatewayName String