AWS v6.60.0 published on Tuesday, Nov 19, 2024 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)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws:appmesh/getRoute:getRoute
arguments:
# arguments dictionary
The following arguments are supported:
- Mesh
Name string - Name of the service mesh in which the virtual router exists.
- Name string
- Name of the route.
- Virtual
Router stringName - Name of the virtual router in which the route exists.
- Mesh
Owner string - AWS account ID of the service mesh's owner.
- Dictionary<string, string>
- Map of tags.
- Mesh
Name string - Name of the service mesh in which the virtual router exists.
- Name string
- Name of the route.
- Virtual
Router stringName - Name of the virtual router in which the route exists.
- Mesh
Owner string - AWS account ID of the service mesh's owner.
- map[string]string
- Map of tags.
- mesh
Name String - Name of the service mesh in which the virtual router exists.
- name String
- Name of the route.
- virtual
Router StringName - Name of the virtual router in which the route exists.
- mesh
Owner String - AWS account ID of the service mesh's owner.
- Map<String,String>
- Map of tags.
- mesh
Name string - Name of the service mesh in which the virtual router exists.
- name string
- Name of the route.
- virtual
Router stringName - Name of the virtual router in which the route exists.
- mesh
Owner 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.
- mesh
Name String - Name of the service mesh in which the virtual router exists.
- name String
- Name of the route.
- virtual
Router StringName - Name of the virtual router in which the route exists.
- mesh
Owner 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.
- Created
Date string - Creation date of the route.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringDate - Last update date of the route.
- Mesh
Name string - Mesh
Owner string - Name string
- Resource
Owner string - Resource owner's AWS account ID.
- Specs
List<Get
Route Spec> - Route specification. See the
aws.appmesh.Route
resource for details. - Dictionary<string, string>
- Map of tags.
- Virtual
Router stringName
- Arn string
- ARN of the route.
- Created
Date string - Creation date of the route.
- Id string
- The provider-assigned unique ID for this managed resource.
- Last
Updated stringDate - Last update date of the route.
- Mesh
Name string - Mesh
Owner string - Name string
- Resource
Owner string - Resource owner's AWS account ID.
- Specs
[]Get
Route Spec - Route specification. See the
aws.appmesh.Route
resource for details. - map[string]string
- Map of tags.
- Virtual
Router stringName
- arn String
- ARN of the route.
- created
Date String - Creation date of the route.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringDate - Last update date of the route.
- mesh
Name String - mesh
Owner String - name String
- resource
Owner String - Resource owner's AWS account ID.
- specs
List<Get
Route Spec> - Route specification. See the
aws.appmesh.Route
resource for details. - Map<String,String>
- Map of tags.
- virtual
Router StringName
- arn string
- ARN of the route.
- created
Date string - Creation date of the route.
- id string
- The provider-assigned unique ID for this managed resource.
- last
Updated stringDate - Last update date of the route.
- mesh
Name string - mesh
Owner string - name string
- resource
Owner string - Resource owner's AWS account ID.
- specs
Get
Route Spec[] - Route specification. See the
aws.appmesh.Route
resource for details. - {[key: string]: string}
- Map of tags.
- virtual
Router 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[Get
Route Spec] - Route specification. See the
aws.appmesh.Route
resource for details. - Mapping[str, str]
- Map of tags.
- virtual_
router_ strname
- arn String
- ARN of the route.
- created
Date String - Creation date of the route.
- id String
- The provider-assigned unique ID for this managed resource.
- last
Updated StringDate - Last update date of the route.
- mesh
Name String - mesh
Owner String - name String
- resource
Owner String - Resource owner's AWS account ID.
- specs List<Property Map>
- Route specification. See the
aws.appmesh.Route
resource for details. - Map<String>
- Map of tags.
- virtual
Router StringName
Supporting Types
GetRouteSpec
GetRouteSpecGrpcRoute
GetRouteSpecGrpcRouteAction
GetRouteSpecGrpcRouteActionWeightedTarget
- Port int
- Virtual
Node string - Weight int
- Port int
- Virtual
Node string - Weight int
- port Integer
- virtual
Node String - weight Integer
- port number
- virtual
Node string - weight number
- port int
- virtual_
node str - weight int
- port Number
- virtual
Node String - weight Number
GetRouteSpecGrpcRouteMatch
- Metadatas
List<Get
Route Spec Grpc Route Match Metadata> - Method
Name string - Port int
- Prefix string
- Service
Name string
- Metadatas
[]Get
Route Spec Grpc Route Match Metadata - Method
Name string - Port int
- Prefix string
- Service
Name string
- metadatas
List<Get
Route Spec Grpc Route Match Metadata> - method
Name String - port Integer
- prefix String
- service
Name String
- metadatas
Get
Route Spec Grpc Route Match Metadata[] - method
Name string - port number
- prefix string
- service
Name string
- metadatas List<Property Map>
- method
Name String - port Number
- prefix String
- service
Name String
GetRouteSpecGrpcRouteMatchMetadata
- Invert bool
- Matches
List<Get
Route Spec Grpc Route Match Metadata Match> - Name string
- Name of the route.
- Invert bool
- Matches
[]Get
Route Spec Grpc Route Match Metadata Match - Name string
- Name of the route.
- invert Boolean
- matches
List<Get
Route Spec Grpc Route Match Metadata Match> - name String
- Name of the route.
- invert boolean
- matches
Get
Route Spec Grpc Route Match Metadata Match[] - name string
- Name of the route.
- invert bool
- matches
Sequence[Get
Route 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
- Grpc
Retry List<string>Events - Http
Retry List<string>Events - Max
Retries int - Per
Retry List<GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout> - Tcp
Retry List<string>Events
- Grpc
Retry []stringEvents - Http
Retry []stringEvents - Max
Retries int - Per
Retry []GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout - Tcp
Retry []stringEvents
- grpc
Retry List<String>Events - http
Retry List<String>Events - max
Retries Integer - per
Retry List<GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout> - tcp
Retry List<String>Events
- grpc
Retry string[]Events - http
Retry string[]Events - max
Retries number - per
Retry GetTimeouts Route Spec Grpc Route Retry Policy Per Retry Timeout[] - tcp
Retry 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
- grpc
Retry List<String>Events - http
Retry List<String>Events - max
Retries Number - per
Retry List<Property Map>Timeouts - tcp
Retry List<String>Events
GetRouteSpecGrpcRouteRetryPolicyPerRetryTimeout
GetRouteSpecGrpcRouteTimeout
GetRouteSpecGrpcRouteTimeoutIdle
GetRouteSpecGrpcRouteTimeoutPerRequest
GetRouteSpecHttp2Route
GetRouteSpecHttp2RouteAction
GetRouteSpecHttp2RouteActionWeightedTarget
- Port int
- Virtual
Node string - Weight int
- Port int
- Virtual
Node string - Weight int
- port Integer
- virtual
Node String - weight Integer
- port number
- virtual
Node string - weight number
- port int
- virtual_
node str - weight int
- port Number
- virtual
Node String - weight Number
GetRouteSpecHttp2RouteMatch
- headers List<Property Map>
- method String
- paths List<Property Map>
- port Number
- prefix String
- query
Parameters List<Property Map> - scheme String
GetRouteSpecHttp2RouteMatchHeader
- Invert bool
- Matches
List<Get
Route Spec Http2Route Match Header Match> - Name string
- Name of the route.
- Invert bool
- Matches
[]Get
Route Spec Http2Route Match Header Match - Name string
- Name of the route.
- invert Boolean
- matches
List<Get
Route Spec Http2Route Match Header Match> - name String
- Name of the route.
- invert boolean
- matches
Get
Route Spec Http2Route Match Header Match[] - name string
- Name of the route.
- invert bool
- matches
Sequence[Get
Route 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<Get
Route Spec Http2Route Match Query Parameter Match> - Name string
- Name of the route.
- Matches
[]Get
Route Spec Http2Route Match Query Parameter Match - Name string
- Name of the route.
- matches
List<Get
Route Spec Http2Route Match Query Parameter Match> - name String
- Name of the route.
- matches
Get
Route Spec Http2Route Match Query Parameter Match[] - name string
- Name of the route.
- matches
Sequence[Get
Route 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
- Http
Retry List<string>Events - Max
Retries int - Per
Retry List<GetTimeouts Route Spec Http2Route Retry Policy Per Retry Timeout> - Tcp
Retry List<string>Events
- http
Retry List<String>Events - max
Retries Integer - per
Retry List<GetTimeouts Route Spec Http2Route Retry Policy Per Retry Timeout> - tcp
Retry 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
- http
Retry List<String>Events - max
Retries Number - per
Retry List<Property Map>Timeouts - tcp
Retry List<String>Events
GetRouteSpecHttp2RouteRetryPolicyPerRetryTimeout
GetRouteSpecHttp2RouteTimeout
GetRouteSpecHttp2RouteTimeoutIdle
GetRouteSpecHttp2RouteTimeoutPerRequest
GetRouteSpecHttpRoute
GetRouteSpecHttpRouteAction
GetRouteSpecHttpRouteActionWeightedTarget
- Port int
- Virtual
Node string - Weight int
- Port int
- Virtual
Node string - Weight int
- port Integer
- virtual
Node String - weight Integer
- port number
- virtual
Node string - weight number
- port int
- virtual_
node str - weight int
- port Number
- virtual
Node String - weight Number
GetRouteSpecHttpRouteMatch
- headers List<Property Map>
- method String
- paths List<Property Map>
- port Number
- prefix String
- query
Parameters List<Property Map> - scheme String
GetRouteSpecHttpRouteMatchHeader
- Invert bool
- Matches
List<Get
Route Spec Http Route Match Header Match> - Name string
- Name of the route.
- Invert bool
- Matches
[]Get
Route Spec Http Route Match Header Match - Name string
- Name of the route.
- invert Boolean
- matches
List<Get
Route Spec Http Route Match Header Match> - name String
- Name of the route.
- invert boolean
- matches
Get
Route Spec Http Route Match Header Match[] - name string
- Name of the route.
- invert bool
- matches
Sequence[Get
Route 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<Get
Route Spec Http Route Match Query Parameter Match> - Name string
- Name of the route.
- Matches
[]Get
Route Spec Http Route Match Query Parameter Match - Name string
- Name of the route.
- matches
List<Get
Route Spec Http Route Match Query Parameter Match> - name String
- Name of the route.
- matches
Get
Route Spec Http Route Match Query Parameter Match[] - name string
- Name of the route.
- matches
Sequence[Get
Route 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
- Http
Retry List<string>Events - Max
Retries int - Per
Retry List<GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout> - Tcp
Retry List<string>Events
- http
Retry List<String>Events - max
Retries Integer - per
Retry List<GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout> - tcp
Retry List<String>Events
- http
Retry string[]Events - max
Retries number - per
Retry GetTimeouts Route Spec Http Route Retry Policy Per Retry Timeout[] - tcp
Retry 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
- http
Retry List<String>Events - max
Retries Number - per
Retry List<Property Map>Timeouts - tcp
Retry List<String>Events
GetRouteSpecHttpRouteRetryPolicyPerRetryTimeout
GetRouteSpecHttpRouteTimeout
GetRouteSpecHttpRouteTimeoutIdle
GetRouteSpecHttpRouteTimeoutPerRequest
GetRouteSpecTcpRoute
GetRouteSpecTcpRouteAction
GetRouteSpecTcpRouteActionWeightedTarget
- Port int
- Virtual
Node string - Weight int
- Port int
- Virtual
Node string - Weight int
- port Integer
- virtual
Node String - weight Integer
- port number
- virtual
Node string - weight number
- port int
- virtual_
node str - weight int
- port Number
- virtual
Node 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
aws
Terraform Provider.