Amazon RoboMaker · JSON Structure

Amazon Robomaker Openapi Launch Config Structure

Information about a launch configuration.

Type: object Properties: 6
RoboticsSimulation

LaunchConfig is a JSON Structure definition published by Amazon RoboMaker, describing 6 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

packageName launchFile environmentVariables portForwardingConfig streamUI command

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-robomaker/refs/heads/main/json-structure/amazon-robomaker-openapi-launch-config-structure.json",
  "description": "Information about a launch configuration.",
  "type": "object",
  "properties": {
    "packageName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Command"
        },
        {
          "description": "The package name."
        }
      ]
    },
    "launchFile": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Command"
        },
        {
          "description": "The launch file name."
        }
      ]
    },
    "environmentVariables": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EnvironmentVariableMap"
        },
        {
          "description": "The environment variables for the application launch."
        }
      ]
    },
    "portForwardingConfig": {
      "allOf": [
        {
          "$ref": "#/components/schemas/PortForwardingConfig"
        },
        {
          "description": "The port forwarding configuration."
        }
      ]
    },
    "streamUI": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Boolean indicating whether a streaming session will be configured for the application. If <code>True</code>, AWS RoboMaker will configure a connection so you can interact with your application as it is running in the simulation. You must configure and launch the component. It must have a graphical user interface. "
        }
      ]
    },
    "command": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CommandList"
        },
        {
          "description": "<p>If you've specified <code>General</code> as the value for your <code>RobotSoftwareSuite</code>, you can use this field to specify a list of commands for your container image.</p> <p>If you've specified <code>SimulationRuntime</code> as the value for your <code>SimulationSoftwareSuite</code>, you can use this field to specify a list of commands for your container image.</p>"
        }
      ]
    }
  },
  "name": "LaunchConfig"
}