AWS App Mesh · Schema

VirtualServiceData

An object that represents a virtual service 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
virtualServiceName object
View JSON Schema on GitHub

JSON Schema

app-mesh-virtual-service-data-schema.json Raw ↑
{
  "type": "object",
  "properties": {
    "meshName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name of the service mesh that the virtual service 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/VirtualServiceSpec"
        },
        {
          "description": "The specifications of the virtual service."
        }
      ]
    },
    "status": {
      "allOf": [
        {
          "$ref": "#/components/schemas/VirtualServiceStatus"
        },
        {
          "description": "The current status of the virtual service."
        }
      ]
    },
    "virtualServiceName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ServiceName"
        },
        {
          "description": "The name of the virtual service."
        }
      ]
    }
  },
  "required": [
    "meshName",
    "metadata",
    "spec",
    "status",
    "virtualServiceName"
  ],
  "description": "An object that represents a virtual service 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-service-data-schema.json",
  "title": "VirtualServiceData"
}