PUT

/v20190125/meshes/{meshName}/virtualGateways

http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateways

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 <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/virtual_gateways.html">Virtual gateways</a>.

Access Token Required: API Key

Path Parameters

meshNamestringrequired

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

Query Params

meshOwnerstring

The Amazon Web Services 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 <a href="https://docs.aws.amazon.com/app-mesh/latest/userguide/sharing.html">Working with shared meshes</a>.

Body Params

specobjectrequired

An object that represents the specification of a service mesh resource.

tagsarray

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.

clientTokenstring

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

virtualGatewayNamestringrequired

The name to use for the virtual gateway.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateways' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

1curl --request PUT \ 2 --url 'http://appmesh.{region}.amazonaws.com/v20190125/meshes/{meshName}/virtualGateways' \ 3 --header 'accept: application/json' \ 4 --header 'content-type: application/json'