CreateVirtualRouter - Amazon App Mesh
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).


Creates a virtual router within a service mesh.

Specify a listener for any inbound traffic that your virtual router receives. Create a virtual router for each protocol and port that you need to route. Virtual routers handle traffic for one or more virtual services within your mesh. After you create your virtual router, create and associate routes for your virtual router that direct incoming requests to different virtual nodes.

For more information about virtual routers, see Virtual routers.

Request Syntax

PUT /v20190125/meshes/meshName/virtualRouters?meshOwner=meshOwner HTTP/1.1 Content-type: application/json { "clientToken": "string", "spec": { "listeners": [ { "portMapping": { "port": number, "protocol": "string" } } ] }, "tags": [ { "key": "string", "value": "string" } ], "virtualRouterName": "string" }

URI Request Parameters

The request uses the following URI parameters.


The name of the service mesh to create the virtual router in.

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes


The Amazon IAM account ID of the service mesh owner. If the account ID is not your own, then the account that you specify must share the mesh with your account before you can create the resource in the service mesh. For more information about mesh sharing, see Working with shared meshes.

Length Constraints: Fixed length of 12.

Request Body

The request accepts the following data in JSON format.


Unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Up to 36 letters, numbers, hyphens, and underscores are allowed.

Type: String

Required: No


The virtual router specification to apply.

Type: VirtualRouterSpec object

Required: Yes


Optional metadata that you can apply to the virtual router to assist with categorization and organization. Each tag consists of a key and an optional value, both of which you define. Tag keys can have a maximum character length of 128 characters, and tag values can have a maximum length of 256 characters.

Type: Array of TagRef objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No


The name to use for the virtual router.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "meshName": "string", "metadata": { "arn": "string", "createdAt": number, "lastUpdatedAt": number, "meshOwner": "string", "resourceOwner": "string", "uid": "string", "version": number }, "spec": { "listeners": [ { "portMapping": { "port": number, "protocol": "string" } } ] }, "status": { "status": "string" }, "virtualRouterName": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.


The name of the service mesh that the virtual router resides in.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.


The associated metadata for the virtual router.

Type: ResourceMetadata object


The specifications of the virtual router.

Type: VirtualRouterSpec object


The current status of the virtual router.

Type: VirtualRouterStatus object


The name of the virtual router.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 255.



The request syntax was malformed. Check your request syntax and try again.

HTTP Status Code: 400


The request contains a client token that was used for a previous update resource call with different specifications. Try the request again with a new client token.

HTTP Status Code: 409


You don't have permissions to perform this action.

HTTP Status Code: 403


The request processing has failed because of an unknown error, exception, or failure.

HTTP Status Code: 500


You have exceeded a service limit for your account. For more information, see Service Limits in the Amazon App Mesh User Guide.

HTTP Status Code: 400


The specified resource doesn't exist. Check your request syntax and try again.

HTTP Status Code: 404


The request has failed due to a temporary failure of the service.

HTTP Status Code: 503


The maximum request rate permitted by the App Mesh APIs has been exceeded for your account. For best results, use an increasing or variable sleep interval between requests.

HTTP Status Code: 429


In the following example or examples, the Authorization header contents (AUTHPARAMS) must be replaced with an Amazon Signature Version 4 signature. For more information about creating these signatures, see Signature Version 4 Signing Process in the Amazon General Reference.

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the Amazon Command Line Interface (Amazon CLI) or one of the Amazon SDKs to make requests to Amazon, these tools automatically sign the requests for you with the access key that you specify when you configure the tools. When you use these tools, you don't need to learn how to sign requests yourself.


The following example creates a virtual router named colorteller-vr in the ecs-mesh service mesh.

Sample Request

PUT /v20190125/meshes/ecs-mesh/virtualRouters HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.56 Python/3.7.0 Darwin/17.7.0 botocore/1.12.46 X-Amz-Date: 20190227T192446Z Authorization: AUTHPARAMS { "spec": { listeners: [ { port: 80, protocol: http } ]}, "virtualRouterName": "colorteller-vr", "clientToken": "e90d8ee2-c111-4431-bfa3-4725a06a84b1" }

Sample Response

HTTP/1.1 200 OK x-amzn-requestid: 770a356d-60e5-45f7-9f47-823eb5f1b750 content-type: application/json content-length: 337 date: Wed, 27 Feb 2019 19:24:46 GMT x-envoy-upstream-service-time: 19 server: envoy Connection: keep-alive { "meshName": "ecs-mesh", "metadata": { "arn": "arn:aws:appmesh:us-east-1:123456789012:mesh/ecs-mesh/virtualRouter/colorteller-vr", "createdAt": 1551295486.588, "lastUpdatedAt": 1551295486.588, "uid": "a756d1e5-ce8f-40a5-afbc-380f61f0c1e0", "version": 1 }, "spec": { "listeners": [ { "portMapping": { "port": 9080, "protocol": "http" } } ] }, "status": { "status": "ACTIVE" }, "virtualRouterName": "colorteller-vr" }

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: