Sign In to the Console
AWS App Mesh
API Reference (API Version 2019-01-25)

AWS Documentation » AWS App Mesh » API Reference » Actions » CreateRoute

CreateRoute

Creates a route that is associated with a virtual router.

You can use the prefix parameter in your route specification for path-based routing of requests. For example, if your virtual service name is my-service.local and you want the route to match requests to my-service.local/metrics, your prefix should be /metrics.

If your route matches a request, you can distribute traffic to one or more target virtual nodes with relative weighting.

Request Syntax

PUT /v20190125/meshes/meshName/virtualRouter/virtualRouterName/routes HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "routeName": "string",
   "spec": { 
      "httpRoute": { 
         "action": { 
            "weightedTargets": [ 
               { 
                  "virtualNode": "string",
                  "weight": number
               }
            ]
         },
         "match": { 
            "prefix": "string"
         }
      },
      "tcpRoute": { 
         "action": { 
            "weightedTargets": [ 
               { 
                  "virtualNode": "string",
                  "weight": number
               }
            ]
         }
      }
   },
   "tags": [ 
      { 
         "key": "string",
         "value": "string"
      }
   ]
}

URI Request Parameters

The request requires the following URI parameters.

meshName

The name of the service mesh to create the route in.

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

virtualRouterName

The name of the virtual router in which to create the route.

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

Request Body

The request accepts the following data in JSON format.

clientToken

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

routeName

The name to use for the route.

Type: String

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

Required: Yes

spec

The route specification to apply.

Type: RouteSpec object

Required: Yes

tags

Optional metadata that you can apply to the route 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

Response Syntax

HTTP/1.1 200
Content-type: application/json

{
   "route": { 
      "meshName": "string",
      "metadata": { 
         "arn": "string",
         "createdAt": number,
         "lastUpdatedAt": number,
         "uid": "string",
         "version": number
      },
      "routeName": "string",
      "spec": { 
         "httpRoute": { 
            "action": { 
               "weightedTargets": [ 
                  { 
                     "virtualNode": "string",
                     "weight": number
                  }
               ]
            },
            "match": { 
               "prefix": "string"
            }
         },
         "tcpRoute": { 
            "action": { 
               "weightedTargets": [ 
                  { 
                     "virtualNode": "string",
                     "weight": number
                  }
               ]
            }
         }
      },
      "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.

route

The full description of your mesh following the create call.

Type: RouteData object

Errors

BadRequestException

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

HTTP Status Code: 400

ConflictException

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

ForbiddenException

You don't have permissions to perform this action.

HTTP Status Code: 403

InternalServerErrorException

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

HTTP Status Code: 500

LimitExceededException

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

HTTP Status Code: 400

NotFoundException

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

HTTP Status Code: 404

ServiceUnavailableException

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

HTTP Status Code: 503

TooManyRequestsException

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

Example

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

You need to learn how to sign HTTP requests only if you intend to manually create them. When you use the AWS Command Line Interface (AWS CLI) or one of the AWS SDKs to make requests to AWS, 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.

Example

The following example creates a route named colorgateway-route for the colorgateway-vr virtual router in the ecs-mesh service mesh. The route directs all traffic to the colorgateway-vn virtual node.

Sample Request

PUT /v20190125/meshes/ecs-mesh/virtualRouter/colorgateway-vr/routes HTTP/1.1
Host: appmesh.us-east-1.amazonaws.com
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: 20190227T192454Z
Authorization: AUTHPARAMS

{
  "routeName": "colorgateway-route",
  "spec": {
    "httpRoute": {
      "action": {
        "weightedTargets": [
          {
            "virtualNode": "colorgateway-vn",
            "weight": 100
          }
        ]
      },
      "match": {
        "prefix": "/"
      }
    }
  },
  "clientToken": "a785b959-201d-49d7-b81d-32e7f393968f"
}

Sample Response

HTTP/1.1 200 OK
x-amzn-requestid: 159941a8-18be-423c-89fe-3beb9542ca3f
content-type: application/json
content-length: 511
date: Wed, 27 Feb 2019 19:24:54 GMT
x-envoy-upstream-service-time: 59
server: envoy
Connection: keep-alive

{
	"meshName": "ecs-mesh",
	"metadata": {
		"arn": "arn:aws:appmesh:us-east-1:012345678910:mesh/ecs-mesh/virtualRouter/colorgateway-vr/route/colorgateway-route",
		"createdAt": 1.551295495004E9,
		"lastUpdatedAt": 1.551295495004E9,
		"uid": "3251bf37-2d01-4b79-be96-d0c36c61511f",
		"version": 1
	},
	"routeName": "colorgateway-route",
	"spec": {
		"httpRoute": {
			"action": {
				"weightedTargets": [{
					"virtualNode": "colorgateway-vn",
					"weight": 100
				}]
			},
			"match": {
				"prefix": "/"
			}
		},
		"tcpRoute": null
	},
	"status": {
		"status": "ACTIVE"
	},
	"virtualRouterName": "colorgateway-vr"
}

See Also

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