AWS App Mesh · Schema
VirtualGatewayData
An object that represents a virtual gateway returned by a describe operation.
DeprecatedEnvoyMicroservicesNetworkingService Mesh
Properties
| Name | Type | Description |
|---|---|---|
| meshName | object | |
| metadata | object | An object that represents metadata for a resource. |
| spec | object | |
| status | object | |
| virtualGatewayName | object |
JSON Schema
{
"type": "object",
"properties": {
"meshName": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"description": "The name of the service mesh that the virtual gateway resides in."
}
]
},
"metadata": {
"type": "object",
"properties": {
"arn": {
"allOf": [
{
"$ref": "#/components/schemas/Arn"
},
{
"description": "The full Amazon Resource Name (ARN) for the resource."
}
]
},
"createdAt": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The Unix epoch timestamp in seconds for when the resource was created."
}
]
},
"lastUpdatedAt": {
"allOf": [
{
"$ref": "#/components/schemas/Timestamp"
},
{
"description": "The Unix epoch timestamp in seconds for when the resource was last updated."
}
]
},
"meshOwner": {
"allOf": [
{
"$ref": "#/components/schemas/AccountId"
},
{
"description": "The Amazon Web Services IAM account ID of the service mesh owner. If the account ID is not your own, then it's the ID of the account that shared the mesh with your account. 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>."
}
]
},
"resourceOwner": {
"allOf": [
{
"$ref": "#/components/schemas/AccountId"
},
{
"description": "The Amazon Web Services IAM account ID of the resource owner. If the account ID is not your own, then it's the ID of the mesh owner or of another account that the mesh is shared with. 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>."
}
]
},
"uid": {
"allOf": [
{
"$ref": "#/components/schemas/String"
},
{
"description": "The unique identifier for the resource."
}
]
},
"version": {
"allOf": [
{
"$ref": "#/components/schemas/Long"
},
{
"description": "The version of the resource. Resources are created at version 1, and this version is incremented each time that they're updated."
}
]
}
},
"required": [
"arn",
"createdAt",
"lastUpdatedAt",
"meshOwner",
"resourceOwner",
"uid",
"version"
],
"description": "An object that represents metadata for a resource."
},
"spec": {
"allOf": [
{
"$ref": "#/components/schemas/VirtualGatewaySpec"
},
{
"description": "The specifications of the virtual gateway."
}
]
},
"status": {
"allOf": [
{
"$ref": "#/components/schemas/VirtualGatewayStatus"
},
{
"description": "The current status of the virtual gateway."
}
]
},
"virtualGatewayName": {
"allOf": [
{
"$ref": "#/components/schemas/ResourceName"
},
{
"description": "The name of the virtual gateway."
}
]
}
},
"required": [
"meshName",
"metadata",
"spec",
"status",
"virtualGatewayName"
],
"description": "An object that represents a virtual gateway returned by a describe operation.",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://raw.githubusercontent.com/api-evangelist/aws-app-mesh/refs/heads/main/json-schema/app-mesh-virtual-gateway-data-schema.json",
"title": "VirtualGatewayData"
}