AWS v6.71.0 published on Friday, Mar 7, 2025 by Pulumi
aws.appmesh.getRoute
Explore with Pulumi AI
The App Mesh Route data source allows details of an App Mesh Route to be retrieved by its name, mesh_name, virtual_router_name, and optionally the mesh_owner.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
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.GetVirtualServiceArgs;
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.getVirtualService(GetVirtualServiceArgs.builder()
            .name("test-route")
            .meshName("test-mesh")
            .virtualRouterName("test-router")
            .build());
    }
}
variables:
  test:
    fn::invoke:
      function: aws:appmesh:getVirtualService
      arguments:
        name: test-route
        meshName: test-mesh
        virtualRouterName: test-router
Using getRoute
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 getRoute(args: GetRouteArgs, opts?: InvokeOptions): Promise<GetRouteResult>
function getRouteOutput(args: GetRouteOutputArgs, opts?: InvokeOptions): Output<GetRouteResult>def get_route(mesh_name: Optional[str] = None,
              mesh_owner: Optional[str] = None,
              name: Optional[str] = None,
              tags: Optional[Mapping[str, str]] = None,
              virtual_router_name: Optional[str] = None,
              opts: Optional[InvokeOptions] = None) -> GetRouteResult
def get_route_output(mesh_name: Optional[pulumi.Input[str]] = None,
              mesh_owner: Optional[pulumi.Input[str]] = None,
              name: Optional[pulumi.Input[str]] = None,
              tags: Optional[pulumi.Input[Mapping[str, pulumi.Input[str]]]] = None,
              virtual_router_name: Optional[pulumi.Input[str]] = None,
              opts: Optional[InvokeOptions] = None) -> Output[GetRouteResult]func LookupRoute(ctx *Context, args *LookupRouteArgs, opts ...InvokeOption) (*LookupRouteResult, error)
func LookupRouteOutput(ctx *Context, args *LookupRouteOutputArgs, opts ...InvokeOption) LookupRouteResultOutput> Note: This function is named LookupRoute in the Go SDK.
public static class GetRoute 
{
    public static Task<GetRouteResult> InvokeAsync(GetRouteArgs args, InvokeOptions? opts = null)
    public static Output<GetRouteResult> Invoke(GetRouteInvokeArgs args, InvokeOptions? opts = null)
}public static CompletableFuture<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
public static Output<GetRouteResult> getRoute(GetRouteArgs args, InvokeOptions options)
fn::invoke:
  function: aws:appmesh/getRoute:getRoute
  arguments:
    # arguments dictionaryThe following arguments are supported:
- MeshName string
- Name of the service mesh in which the virtual router exists.
- Name string
- Name of the route.
- VirtualRouter stringName 
- Name of the virtual router in which the route exists.
- MeshOwner string
- AWS account ID of the service mesh's owner.
- Dictionary<string, string>
- Map of tags.
- MeshName string
- Name of the service mesh in which the virtual router exists.
- Name string
- Name of the route.
- VirtualRouter stringName 
- Name of the virtual router in which the route exists.
- MeshOwner string
- AWS account ID of the service mesh's owner.
- map[string]string
- Map of tags.
- meshName String
- Name of the service mesh in which the virtual router exists.
- name String
- Name of the route.
- virtualRouter StringName 
- Name of the virtual router in which the route exists.
- meshOwner String
- AWS account ID of the service mesh's owner.
- Map<String,String>
- Map of tags.
- meshName string
- Name of the service mesh in which the virtual router exists.
- name string
- Name of the route.
- virtualRouter stringName 
- Name of the virtual router in which the route exists.
- meshOwner string
- AWS account ID of the service mesh's owner.
- {[key: string]: string}
- Map of tags.
- mesh_name str
- Name of the service mesh in which the virtual router exists.
- name str
- Name of the route.
- virtual_router_ strname 
- Name of the virtual router in which the route exists.
- mesh_owner str
- AWS account ID of the service mesh's owner.
- Mapping[str, str]
- Map of tags.
- meshName String
- Name of the service mesh in which the virtual router exists.
- name String
- Name of the route.
- virtualRouter StringName 
- Name of the virtual router in which the route exists.
- meshOwner String
- AWS account ID of the service mesh's owner.
- Map<String>
- Map of tags.
getRoute Result
The following output properties are available:
- Arn string
- ARN of the route.
- CreatedDate string
- Creation date of the route.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastUpdated stringDate 
- Last update date of the route.
- MeshName string
- MeshOwner string
- Name string
- ResourceOwner string
- Resource owner's AWS account ID.
- Specs
List<GetRoute Spec> 
- Route specification. See the aws.appmesh.Routeresource for details.
- Dictionary<string, string>
- Map of tags.
- VirtualRouter stringName 
- Arn string
- ARN of the route.
- CreatedDate string
- Creation date of the route.
- Id string
- The provider-assigned unique ID for this managed resource.
- LastUpdated stringDate 
- Last update date of the route.
- MeshName string
- MeshOwner string
- Name string
- ResourceOwner string
- Resource owner's AWS account ID.
- Specs
[]GetRoute Spec 
- Route specification. See the aws.appmesh.Routeresource for details.
- map[string]string
- Map of tags.
- VirtualRouter stringName 
- arn String
- ARN of the route.
- createdDate String
- Creation date of the route.
- id String
- The provider-assigned unique ID for this managed resource.
- lastUpdated StringDate 
- Last update date of the route.
- meshName String
- meshOwner String
- name String
- resourceOwner String
- Resource owner's AWS account ID.
- specs
List<GetRoute Spec> 
- Route specification. See the aws.appmesh.Routeresource for details.
- Map<String,String>
- Map of tags.
- virtualRouter StringName 
- arn string
- ARN of the route.
- createdDate string
- Creation date of the route.
- id string
- The provider-assigned unique ID for this managed resource.
- lastUpdated stringDate 
- Last update date of the route.
- meshName string
- meshOwner string
- name string
- resourceOwner string
- Resource owner's AWS account ID.
- specs
GetRoute Spec[] 
- Route specification. See the aws.appmesh.Routeresource for details.
- {[key: string]: string}
- Map of tags.
- virtualRouter stringName 
- arn str
- ARN of the route.
- created_date str
- Creation date of the route.
- id str
- The provider-assigned unique ID for this managed resource.
- last_updated_ strdate 
- Last update date of the route.
- mesh_name str
- mesh_owner str
- name str
- resource_owner str
- Resource owner's AWS account ID.
- specs
Sequence[GetRoute Spec] 
- Route specification. See the aws.appmesh.Routeresource for details.
- Mapping[str, str]
- Map of tags.
- virtual_router_ strname 
- arn String
- ARN of the route.
- createdDate String
- Creation date of the route.
- id String
- The provider-assigned unique ID for this managed resource.
- lastUpdated StringDate 
- Last update date of the route.
- meshName String
- meshOwner String
- name String
- resourceOwner String
- Resource owner's AWS account ID.
- specs List<Property Map>
- Route specification. See the aws.appmesh.Routeresource for details.
- Map<String>
- Map of tags.
- virtualRouter StringName 
Supporting Types
GetRouteSpec  
GetRouteSpecGrpcRoute    
GetRouteSpecGrpcRouteAction     
GetRouteSpecGrpcRouteActionWeightedTarget       
- Port int
- VirtualNode string
- Weight int
- Port int
- VirtualNode string
- Weight int
- port Integer
- virtualNode String
- weight Integer
- port number
- virtualNode string
- weight number
- port int
- virtual_node str
- weight int
- port Number
- virtualNode String
- weight Number
GetRouteSpecGrpcRouteMatch     
- Metadatas
List<GetRoute Spec Grpc Route Match Metadata> 
- MethodName string
- Port int
- Prefix string
- ServiceName string
- Metadatas
[]GetRoute Spec Grpc Route Match Metadata 
- MethodName string
- Port int
- Prefix string
- ServiceName string
- metadatas
List<GetRoute Spec Grpc Route Match Metadata> 
- methodName String
- port Integer
- prefix String
- serviceName String
- metadatas
GetRoute Spec Grpc Route Match Metadata[] 
- methodName string
- port number
- prefix string
- serviceName string
- metadatas List<Property Map>
- methodName String
- port Number
- prefix String
- serviceName String
GetRouteSpecGrpcRouteMatchMetadata      
- Invert bool
- Matches
List<GetRoute Spec Grpc Route Match Metadata Match> 
- Name string
- Name of the route.
- Invert bool
- Matches
[]GetRoute Spec Grpc Route Match Metadata Match 
- Name string
- Name of the route.
- invert Boolean
- matches
List<GetRoute Spec Grpc Route Match Metadata Match> 
- name String
- Name of the route.
- invert boolean
- matches
GetRoute Spec Grpc Route Match Metadata Match[] 
- name string
- Name of the route.
- invert bool
- matches
Sequence[GetRoute Spec Grpc Route Match Metadata Match] 
- name str
- Name of the route.
- invert Boolean
- matches List<Property Map>
- name String
- Name of the route.
GetRouteSpecGrpcRouteMatchMetadataMatch       
GetRouteSpecGrpcRouteMatchMetadataMatchRange        
GetRouteSpecGrpcRouteRetryPolicy      
- GrpcRetry List<string>Events 
- HttpRetry List<string>Events 
- MaxRetries int
- PerRetry List<GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout> 
- TcpRetry List<string>Events 
- GrpcRetry []stringEvents 
- HttpRetry []stringEvents 
- MaxRetries int
- PerRetry []GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout 
- TcpRetry []stringEvents 
- grpcRetry List<String>Events 
- httpRetry List<String>Events 
- maxRetries Integer
- perRetry List<GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout> 
- tcpRetry List<String>Events 
- grpcRetry string[]Events 
- httpRetry string[]Events 
- maxRetries number
- perRetry GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout[] 
- tcpRetry string[]Events 
- grpc_retry_ Sequence[str]events 
- http_retry_ Sequence[str]events 
- max_retries int
- per_retry_ Sequence[Gettimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout] 
- tcp_retry_ Sequence[str]events 
- grpcRetry List<String>Events 
- httpRetry List<String>Events 
- maxRetries Number
- perRetry List<Property Map>Timeouts 
- tcpRetry List<String>Events 
GetRouteSpecGrpcRouteRetryPolicyPerRetryTimeout         
GetRouteSpecGrpcRouteTimeout     
GetRouteSpecGrpcRouteTimeoutIdle      
GetRouteSpecGrpcRouteTimeoutPerRequest       
GetRouteSpecHttp2Route   
GetRouteSpecHttp2RouteAction    
GetRouteSpecHttp2RouteActionWeightedTarget      
- Port int
- VirtualNode string
- Weight int
- Port int
- VirtualNode string
- Weight int
- port Integer
- virtualNode String
- weight Integer
- port number
- virtualNode string
- weight number
- port int
- virtual_node str
- weight int
- port Number
- virtualNode String
- weight Number
GetRouteSpecHttp2RouteMatch    
- headers List<Property Map>
- method String
- paths List<Property Map>
- port Number
- prefix String
- queryParameters List<Property Map>
- scheme String
GetRouteSpecHttp2RouteMatchHeader     
- Invert bool
- Matches
List<GetRoute Spec Http2Route Match Header Match> 
- Name string
- Name of the route.
- Invert bool
- Matches
[]GetRoute Spec Http2Route Match Header Match 
- Name string
- Name of the route.
- invert Boolean
- matches
List<GetRoute Spec Http2Route Match Header Match> 
- name String
- Name of the route.
- invert boolean
- matches
GetRoute Spec Http2Route Match Header Match[] 
- name string
- Name of the route.
- invert bool
- matches
Sequence[GetRoute Spec Http2Route Match Header Match] 
- name str
- Name of the route.
- invert Boolean
- matches List<Property Map>
- name String
- Name of the route.
GetRouteSpecHttp2RouteMatchHeaderMatch      
GetRouteSpecHttp2RouteMatchHeaderMatchRange       
GetRouteSpecHttp2RouteMatchPath     
GetRouteSpecHttp2RouteMatchQueryParameter      
- Matches
List<GetRoute Spec Http2Route Match Query Parameter Match> 
- Name string
- Name of the route.
- Matches
[]GetRoute Spec Http2Route Match Query Parameter Match 
- Name string
- Name of the route.
- matches
List<GetRoute Spec Http2Route Match Query Parameter Match> 
- name String
- Name of the route.
- matches
GetRoute Spec Http2Route Match Query Parameter Match[] 
- name string
- Name of the route.
- matches
Sequence[GetRoute Spec Http2Route Match Query Parameter Match] 
- name str
- Name of the route.
- matches List<Property Map>
- name String
- Name of the route.
GetRouteSpecHttp2RouteMatchQueryParameterMatch       
- Exact string
- Exact string
- exact String
- exact string
- exact str
- exact String
GetRouteSpecHttp2RouteRetryPolicy     
- HttpRetry List<string>Events 
- MaxRetries int
- PerRetry List<GetTimeouts Route Spec Http2Route Retry Policy Per Retry Timeout> 
- TcpRetry List<string>Events 
- httpRetry List<String>Events 
- maxRetries Integer
- perRetry List<GetTimeouts Route Spec Http2Route Retry Policy Per Retry Timeout> 
- tcpRetry List<String>Events 
- http_retry_ Sequence[str]events 
- max_retries int
- per_retry_ Sequence[Gettimeouts Route Spec Http2Route Retry Policy Per Retry Timeout] 
- tcp_retry_ Sequence[str]events 
- httpRetry List<String>Events 
- maxRetries Number
- perRetry List<Property Map>Timeouts 
- tcpRetry List<String>Events 
GetRouteSpecHttp2RouteRetryPolicyPerRetryTimeout        
GetRouteSpecHttp2RouteTimeout    
GetRouteSpecHttp2RouteTimeoutIdle     
GetRouteSpecHttp2RouteTimeoutPerRequest      
GetRouteSpecHttpRoute    
GetRouteSpecHttpRouteAction     
GetRouteSpecHttpRouteActionWeightedTarget       
- Port int
- VirtualNode string
- Weight int
- Port int
- VirtualNode string
- Weight int
- port Integer
- virtualNode String
- weight Integer
- port number
- virtualNode string
- weight number
- port int
- virtual_node str
- weight int
- port Number
- virtualNode String
- weight Number
GetRouteSpecHttpRouteMatch     
- headers List<Property Map>
- method String
- paths List<Property Map>
- port Number
- prefix String
- queryParameters List<Property Map>
- scheme String
GetRouteSpecHttpRouteMatchHeader      
- Invert bool
- Matches
List<GetRoute Spec Http Route Match Header Match> 
- Name string
- Name of the route.
- Invert bool
- Matches
[]GetRoute Spec Http Route Match Header Match 
- Name string
- Name of the route.
- invert Boolean
- matches
List<GetRoute Spec Http Route Match Header Match> 
- name String
- Name of the route.
- invert boolean
- matches
GetRoute Spec Http Route Match Header Match[] 
- name string
- Name of the route.
- invert bool
- matches
Sequence[GetRoute Spec Http Route Match Header Match] 
- name str
- Name of the route.
- invert Boolean
- matches List<Property Map>
- name String
- Name of the route.
GetRouteSpecHttpRouteMatchHeaderMatch       
GetRouteSpecHttpRouteMatchHeaderMatchRange        
GetRouteSpecHttpRouteMatchPath      
GetRouteSpecHttpRouteMatchQueryParameter       
- Matches
List<GetRoute Spec Http Route Match Query Parameter Match> 
- Name string
- Name of the route.
- Matches
[]GetRoute Spec Http Route Match Query Parameter Match 
- Name string
- Name of the route.
- matches
List<GetRoute Spec Http Route Match Query Parameter Match> 
- name String
- Name of the route.
- matches
GetRoute Spec Http Route Match Query Parameter Match[] 
- name string
- Name of the route.
- matches
Sequence[GetRoute Spec Http Route Match Query Parameter Match] 
- name str
- Name of the route.
- matches List<Property Map>
- name String
- Name of the route.
GetRouteSpecHttpRouteMatchQueryParameterMatch        
- Exact string
- Exact string
- exact String
- exact string
- exact str
- exact String
GetRouteSpecHttpRouteRetryPolicy      
- HttpRetry List<string>Events 
- MaxRetries int
- PerRetry List<GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout> 
- TcpRetry List<string>Events 
- httpRetry List<String>Events 
- maxRetries Integer
- perRetry List<GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout> 
- tcpRetry List<String>Events 
- httpRetry string[]Events 
- maxRetries number
- perRetry GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout[] 
- tcpRetry string[]Events 
- http_retry_ Sequence[str]events 
- max_retries int
- per_retry_ Sequence[Gettimeouts Route Spec Http Route Retry Policy Per Retry Timeout] 
- tcp_retry_ Sequence[str]events 
- httpRetry List<String>Events 
- maxRetries Number
- perRetry List<Property Map>Timeouts 
- tcpRetry List<String>Events 
GetRouteSpecHttpRouteRetryPolicyPerRetryTimeout         
GetRouteSpecHttpRouteTimeout     
GetRouteSpecHttpRouteTimeoutIdle      
GetRouteSpecHttpRouteTimeoutPerRequest       
GetRouteSpecTcpRoute    
GetRouteSpecTcpRouteAction     
GetRouteSpecTcpRouteActionWeightedTarget       
- Port int
- VirtualNode string
- Weight int
- Port int
- VirtualNode string
- Weight int
- port Integer
- virtualNode String
- weight Integer
- port number
- virtualNode string
- weight number
- port int
- virtual_node str
- weight int
- port Number
- virtualNode String
- weight Number
GetRouteSpecTcpRouteMatch     
- Port int
- Port int
- port Integer
- port number
- port int
- port Number
GetRouteSpecTcpRouteTimeout     
GetRouteSpecTcpRouteTimeoutIdle      
Package Details
- Repository
- AWS Classic pulumi/pulumi-aws
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the awsTerraform Provider.