1. Packages
  2. AWS
  3. API Docs
  4. appmesh
  5. getRoute
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

aws.appmesh.getRoute

Explore with Pulumi AI

aws logo
AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi

    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)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: aws:appmesh/getRoute:getRoute
      arguments:
        # arguments dictionary

    The following arguments are supported:

    MeshName string
    Name of the service mesh in which the virtual router exists.
    Name string
    Name of the route.
    VirtualRouterName string
    Name of the virtual router in which the route exists.
    MeshOwner string
    AWS account ID of the service mesh's owner.
    Tags 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.
    VirtualRouterName string
    Name of the virtual router in which the route exists.
    MeshOwner string
    AWS account ID of the service mesh's owner.
    Tags 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.
    virtualRouterName String
    Name of the virtual router in which the route exists.
    meshOwner String
    AWS account ID of the service mesh's owner.
    tags 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.
    virtualRouterName string
    Name of the virtual router in which the route exists.
    meshOwner string
    AWS account ID of the service mesh's owner.
    tags {[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_name str
    Name of the virtual router in which the route exists.
    mesh_owner str
    AWS account ID of the service mesh's owner.
    tags 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.
    virtualRouterName String
    Name of the virtual router in which the route exists.
    meshOwner String
    AWS account ID of the service mesh's owner.
    tags 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.
    LastUpdatedDate string
    Last update date of the route.
    MeshName string
    MeshOwner string
    Name string
    ResourceOwner string
    Resource owner's AWS account ID.
    Specs List<GetRouteSpec>
    Route specification. See the aws.appmesh.Route resource for details.
    Tags Dictionary<string, string>
    Map of tags.
    VirtualRouterName string
    Arn string
    ARN of the route.
    CreatedDate string
    Creation date of the route.
    Id string
    The provider-assigned unique ID for this managed resource.
    LastUpdatedDate string
    Last update date of the route.
    MeshName string
    MeshOwner string
    Name string
    ResourceOwner string
    Resource owner's AWS account ID.
    Specs []GetRouteSpec
    Route specification. See the aws.appmesh.Route resource for details.
    Tags map[string]string
    Map of tags.
    VirtualRouterName string
    arn String
    ARN of the route.
    createdDate String
    Creation date of the route.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    Last update date of the route.
    meshName String
    meshOwner String
    name String
    resourceOwner String
    Resource owner's AWS account ID.
    specs List<GetRouteSpec>
    Route specification. See the aws.appmesh.Route resource for details.
    tags Map<String,String>
    Map of tags.
    virtualRouterName String
    arn string
    ARN of the route.
    createdDate string
    Creation date of the route.
    id string
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate string
    Last update date of the route.
    meshName string
    meshOwner string
    name string
    resourceOwner string
    Resource owner's AWS account ID.
    specs GetRouteSpec[]
    Route specification. See the aws.appmesh.Route resource for details.
    tags {[key: string]: string}
    Map of tags.
    virtualRouterName string
    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_date str
    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[GetRouteSpec]
    Route specification. See the aws.appmesh.Route resource for details.
    tags Mapping[str, str]
    Map of tags.
    virtual_router_name str
    arn String
    ARN of the route.
    createdDate String
    Creation date of the route.
    id String
    The provider-assigned unique ID for this managed resource.
    lastUpdatedDate String
    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.Route resource for details.
    tags Map<String>
    Map of tags.
    virtualRouterName String

    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 Number
    virtualNode String
    weight Number

    GetRouteSpecGrpcRouteMatch

    GetRouteSpecGrpcRouteMatchMetadata

    invert Boolean
    matches List<Property Map>
    name String
    Name of the route.

    GetRouteSpecGrpcRouteMatchMetadataMatch

    GetRouteSpecGrpcRouteMatchMetadataMatchRange

    End int
    Start int
    End int
    Start int
    end Integer
    start Integer
    end number
    start number
    end int
    start int
    end Number
    start Number

    GetRouteSpecGrpcRouteRetryPolicy

    GetRouteSpecGrpcRouteRetryPolicyPerRetryTimeout

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecGrpcRouteTimeout

    GetRouteSpecGrpcRouteTimeoutIdle

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecGrpcRouteTimeoutPerRequest

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    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 Number
    virtualNode String
    weight Number

    GetRouteSpecHttp2RouteMatch

    GetRouteSpecHttp2RouteMatchHeader

    invert Boolean
    matches List<Property Map>
    name String
    Name of the route.

    GetRouteSpecHttp2RouteMatchHeaderMatch

    GetRouteSpecHttp2RouteMatchHeaderMatchRange

    End int
    Start int
    End int
    Start int
    end Integer
    start Integer
    end number
    start number
    end int
    start int
    end Number
    start Number

    GetRouteSpecHttp2RouteMatchPath

    Exact string
    Regex string
    Exact string
    Regex string
    exact String
    regex String
    exact string
    regex string
    exact str
    regex str
    exact String
    regex String

    GetRouteSpecHttp2RouteMatchQueryParameter

    matches List<Property Map>
    name String
    Name of the route.

    GetRouteSpecHttp2RouteMatchQueryParameterMatch

    Exact string
    Exact string
    exact String
    exact string
    exact str
    exact String

    GetRouteSpecHttp2RouteRetryPolicy

    GetRouteSpecHttp2RouteRetryPolicyPerRetryTimeout

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecHttp2RouteTimeout

    GetRouteSpecHttp2RouteTimeoutIdle

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecHttp2RouteTimeoutPerRequest

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    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 Number
    virtualNode String
    weight Number

    GetRouteSpecHttpRouteMatch

    GetRouteSpecHttpRouteMatchHeader

    invert Boolean
    matches List<Property Map>
    name String
    Name of the route.

    GetRouteSpecHttpRouteMatchHeaderMatch

    GetRouteSpecHttpRouteMatchHeaderMatchRange

    End int
    Start int
    End int
    Start int
    end Integer
    start Integer
    end number
    start number
    end int
    start int
    end Number
    start Number

    GetRouteSpecHttpRouteMatchPath

    Exact string
    Regex string
    Exact string
    Regex string
    exact String
    regex String
    exact string
    regex string
    exact str
    regex str
    exact String
    regex String

    GetRouteSpecHttpRouteMatchQueryParameter

    matches List<Property Map>
    name String
    Name of the route.

    GetRouteSpecHttpRouteMatchQueryParameterMatch

    Exact string
    Exact string
    exact String
    exact string
    exact str
    exact String

    GetRouteSpecHttpRouteRetryPolicy

    GetRouteSpecHttpRouteRetryPolicyPerRetryTimeout

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecHttpRouteTimeout

    GetRouteSpecHttpRouteTimeoutIdle

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    GetRouteSpecHttpRouteTimeoutPerRequest

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    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 Number
    virtualNode String
    weight Number

    GetRouteSpecTcpRouteMatch

    Port int
    Port int
    port Integer
    port number
    port int
    port Number

    GetRouteSpecTcpRouteTimeout

    GetRouteSpecTcpRouteTimeoutIdle

    Unit string
    Value int
    Unit string
    Value int
    unit String
    value Integer
    unit string
    value number
    unit str
    value int
    unit String
    value Number

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.60.0 published on Tuesday, Nov 19, 2024 by Pulumi