CreateVirtualGateway - AWS App Mesh


Creates a virtual gateway.

A virtual gateway allows resources outside your mesh to communicate to resources that are inside your mesh. The virtual gateway represents an Envoy proxy running in an Amazon ECS task, in a Kubernetes service, or on an Amazon EC2 instance. Unlike a virtual node, which represents an Envoy running with an application, a virtual gateway represents Envoy deployed by itself.

For more information about virtual gateways, see Virtual gateways.

Request Syntax

PUT /v20190125/meshes/meshName/virtualGateways?meshOwner=meshOwner HTTP/1.1 Content-type: application/json { "clientToken": "string", "spec": { "backendDefaults": { "clientPolicy": { "tls": { "certificate": { ... }, "enforce": boolean, "ports": [ number ], "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } }, "listeners": [ { "connectionPool": { ... }, "healthCheck": { "healthyThreshold": number, "intervalMillis": number, "path": "string", "port": number, "protocol": "string", "timeoutMillis": number, "unhealthyThreshold": number }, "portMapping": { "port": number, "protocol": "string" }, "tls": { "certificate": { ... }, "mode": "string", "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } ], "logging": { "accessLog": { ... } } }, "tags": [ { "key": "string", "value": "string" } ], "virtualGatewayName": "string" }

URI Request Parameters

The request uses the following URI parameters.


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

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

Required: Yes


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.

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 gateway specification to apply.

Type: VirtualGatewaySpec object

Required: Yes


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

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": { "backendDefaults": { "clientPolicy": { "tls": { "certificate": { ... }, "enforce": boolean, "ports": [ number ], "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } }, "listeners": [ { "connectionPool": { ... }, "healthCheck": { "healthyThreshold": number, "intervalMillis": number, "path": "string", "port": number, "protocol": "string", "timeoutMillis": number, "unhealthyThreshold": number }, "portMapping": { "port": number, "protocol": "string" }, "tls": { "certificate": { ... }, "mode": "string", "validation": { "subjectAlternativeNames": { "match": { "exact": [ "string" ] } }, "trust": { ... } } } } ], "logging": { "accessLog": { ... } } }, "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.


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

Type: String

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


An object that represents metadata for a resource.

Type: ResourceMetadata object


The specifications of the virtual gateway.

Type: VirtualGatewaySpec object


The current status of the virtual gateway.

Type: VirtualGatewayStatus object


The name of the virtual gateway.

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 AWS 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 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.


The following example creates a virtual gateway named myVirtualGateway in the apps service mesh. The virtual gateway listens for http2 traffic on port 80.

Sample Request

PUT /v20190125/meshes/apps/virtualGateways HTTP/1.1 Host: Accept-Encoding: identity User-Agent: aws-cli/1.16.298 Python/3.6.0 Windows/10 botocore/1.13.34 X-Amz-Date: 20200706T144617Z Authorization: AUTHPARAMS Content-Length: 174 { "spec": { "listeners": [{ "portMapping": { "port": 80, "protocol": "http2" } }] }, "virtualGatewayName": "myVirtualGateway", "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: 513 date: Mon, 06 Jul 2020 14:46:17 GMT x-envoy-upstream-service-time: 33 server: envoy Connection: keep-alive { "meshName": "apps", "metadata": { "arn": "arn:aws:appmesh:us-west-2:123456789012:mesh/apps/virtualGateway/myVirtualGateway", "createdAt": 1.594046778215E9, "lastUpdatedAt": 1.594046778215E9, "meshOwner": "123456789012", "resourceOwner": "123456789012, "uid": "ff111ff2-33ff-4ff4-ffff-111f111f111f", "version": 1 }, "spec": { "backendDefaults": null, "listeners": [{ "healthCheck": null, "portMapping": { "port": 80, "protocol": "http2" }, "tls": null }], "logging": 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: