Domain

A collection of app instances that run the same executable app code and have the same launch options and commands.

For more information about domains, see Key concepts: Domains in the SimSpace Weaver User Guide.

DefenseDigital TwinSimulationSpatial Simulation

Properties

Name Type Description
Lifecycle object
Name object
View JSON Schema on GitHub

JSON Schema

amazon-simspace-weaver-domain-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-domain-schema.json",
  "title": "Domain",
  "description": "<p>A collection of app instances that run the same executable app code and have the same launch options and commands.</p> <p>For more information about domains, see <a href=\"https://docs.aws.amazon.com/simspaceweaver/latest/userguide/what-is_key-concepts.html#what-is_key-concepts_domains\">Key concepts: Domains</a> in the <i>SimSpace Weaver User Guide</i>.</p>",
  "type": "object",
  "properties": {
    "Lifecycle": {
      "allOf": [
        {
          "$ref": "#/components/schemas/LifecycleManagementStrategy"
        },
        {
          "description": "<p>The type of lifecycle management for apps in the domain. Indicates whether apps in this domain are <i>managed</i> (SimSpace Weaver starts and stops the apps) or <i>unmanaged</i> (you must start and stop the apps).</p> <p class=\"title\"> <b>Lifecycle types</b> </p> <ul> <li> <p> <code>PerWorker</code> \u2013 Managed: SimSpace Weaver starts one app on each worker.</p> </li> <li> <p> <code>BySpatialSubdivision</code> \u2013 Managed: SimSpace Weaver starts one app for each spatial partition.</p> </li> <li> <p> <code>ByRequest</code> \u2013 Unmanaged: You use the <code>StartApp</code> API to start the apps and use the <code>StopApp</code> API to stop the apps.</p> </li> </ul>"
        }
      ]
    },
    "Name": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SimSpaceWeaverResourceName"
        },
        {
          "description": "The name of the domain."
        }
      ]
    }
  }
}