SimulationAppPortMapping

A collection of TCP/UDP ports for a custom or service app.

DefenseDigital TwinSimulationSpatial Simulation

Properties

Name Type Description
Actual object
Declared object
View JSON Schema on GitHub

JSON Schema

amazon-simspace-weaver-simulation-app-port-mapping-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-simspace-weaver/refs/heads/main/json-schema/amazon-simspace-weaver-simulation-app-port-mapping-schema.json",
  "title": "SimulationAppPortMapping",
  "description": "A collection of TCP/UDP ports for a custom or service app.",
  "type": "object",
  "properties": {
    "Actual": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortNumber"
        },
        {
          "description": "The TCP/UDP port number of the running app. SimSpace Weaver dynamically assigns this port number when the app starts. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. Clients connect to the app using the app's IP address and the <code>Actual</code> port number."
        }
      ]
    },
    "Declared": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortNumber"
        },
        {
          "description": "The TCP/UDP port number of the app, declared in the simulation schema. SimSpace Weaver maps the <code>Declared</code> port to the <code>Actual</code> port. The source code for the app should bind to the <code>Declared</code> port."
        }
      ]
    }
  }
}