CreateGatewayRoute
Creates a gateway route.
A gateway route is attached to a virtual gateway and routes traffic to an existing virtual service. If a route matches a request, it can distribute traffic to a target virtual service.
For more information about gateway routes, see Gateway routes.
Request Syntax
PUT /v20190125/meshes/meshName/virtualGateway/virtualGatewayName/gatewayRoutes?meshOwner=meshOwner HTTP/1.1
Content-type: application/json
{
"clientToken": "string",
"gatewayRouteName": "string",
"spec": {
"grpcRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"hostname": {
"exact": "string",
"suffix": "string"
},
"metadata": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"port": number,
"serviceName": "string"
}
},
"http2Route": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "string",
"value": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
]
}
},
"httpRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "string",
"value": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
]
}
},
"priority": number
},
"tags": [
{
"key": "string",
"value": "string"
}
]
}URI Request Parameters
The request uses the following URI parameters.
- meshName
-
The name of the service mesh to create the gateway route in.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- meshOwner
-
The AWS 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.
- virtualGatewayName
-
The name of the virtual gateway to associate the gateway route with. If the virtual gateway is in a shared mesh, then you must be the owner of the virtual gateway resource.
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
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
- gatewayRouteName
-
The name to use for the gateway route.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Required: Yes
- spec
-
The gateway route specification to apply.
Type: GatewayRouteSpec object
Required: Yes
-
Optional metadata that you can apply to the gateway 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
{
"gatewayRouteName": "string",
"meshName": "string",
"metadata": {
"arn": "string",
"createdAt": number,
"lastUpdatedAt": number,
"meshOwner": "string",
"resourceOwner": "string",
"uid": "string",
"version": number
},
"spec": {
"grpcRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"hostname": {
"exact": "string",
"suffix": "string"
},
"metadata": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"port": number,
"serviceName": "string"
}
},
"http2Route": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "string",
"value": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
]
}
},
"httpRoute": {
"action": {
"rewrite": {
"hostname": {
"defaultTargetHostname": "string"
},
"path": {
"exact": "string"
},
"prefix": {
"defaultPrefix": "string",
"value": "string"
}
},
"target": {
"port": number,
"virtualService": {
"virtualServiceName": "string"
}
}
},
"match": {
"headers": [
{
"invert": boolean,
"match": { ... },
"name": "string"
}
],
"hostname": {
"exact": "string",
"suffix": "string"
},
"method": "string",
"path": {
"exact": "string",
"regex": "string"
},
"port": number,
"prefix": "string",
"queryParameters": [
{
"match": {
"exact": "string"
},
"name": "string"
}
]
}
},
"priority": number
},
"status": {
"status": "string"
},
"virtualGatewayName": "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.
- gatewayRouteName
-
The name of the gateway route.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- meshName
-
The name of the service mesh that the resource resides in.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
- metadata
-
An object that represents metadata for a resource.
Type: ResourceMetadata object
- spec
-
The specifications of the gateway route.
Type: GatewayRouteSpec object
- status
-
The status of the gateway route.
Type: GatewayRouteStatus object
- virtualGatewayName
-
The virtual gateway that the gateway route is associated with.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
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
Examples
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)
Example
The following example creates an HTTP/2 gateway route named
myGatewayRoute that is associated to a virtual gateway named
myVirtualGateway in the apps service mesh. The route
routes all traffic to the virtual service named
myservicea.svc.cluster.local.
Sample Request
PUT /v20190125/meshes/apps/virtualGateways HTTP/1.1
Host: appmesh.us-west-2.amazonaws.com
Accept-Encoding: identity
User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34
X-Amz-Date: 20200608T194401Z
Authorization: AUTHPARAMS
{
"gatewayRouteName": "myGatewayRoute",
"spec": {
"http2Route": {
"action": {
"target": {
"virtualService": {
"virtualServiceName": "myservicea.svc.cluster.local"
}
}
},
"match": {
"prefix": "/"
}
}
},
"clientToken": "1aa1111a-1111-1111-111a-a1a1a1aa111a"
}Sample Response
HTTP/1.1 200 OK
x-amzn-requestid: 696b569b-3593-446d-832c-0a38ce1c53ac
content-type: application/json
content-length: 517
date: Mon, 08 Jun 2020 19:44:02 GMT
x-envoy-upstream-service-time: 48
server: envoy
Connection: keep-alive
{
"gatewayRouteName": "myGatewayRoute",
"meshName": "myApps",
"metadata": {
"arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway/gatewayRoute/myGatewayRoute",
"createdAt": 1.591642091122E9,
"lastUpdatedAt": 1.591642091122E9,
"meshOwner": "123456789012",
"resourceOwner": "123456789012",
"uid": "ff111ff2-33ff-4ff4-ffff-111f111f111f",
"version": 1
},
"spec": {
"grpcRoute": null,
"http2Route": {
"action": {
"target": {
"virtualService": {
"virtualServiceName": "myservicea.svc.cluster.local"
}
}
},
"match": {
"prefix": "/"
}
},
"httpRoute": null
},
"status": {
"status": "ACTIVE"
},
"virtualGatewayName": "myVirtualGateway"
}See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
