Amazon IoT Greengrass · JSON Structure

Iot Greengrass Component Deployment Specification Structure

Contains information about a component to deploy.

Type: object Properties: 3
Edge ComputingIoTLambdaMachine LearningReal-Time Processing

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

Properties

componentVersion configurationUpdate runWith

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-iot-greengrass/refs/heads/main/json-structure/iot-greengrass-component-deployment-specification-structure.json",
  "name": "ComponentDeploymentSpecification",
  "description": "Contains information about a component to deploy.",
  "type": "object",
  "properties": {
    "componentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentVersionString"
        },
        {
          "description": "The version of the component."
        }
      ]
    },
    "configurationUpdate": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentConfigurationUpdate"
        },
        {
          "description": "The configuration updates to deploy for the component. You can define <i>reset</i> updates and <i>merge</i> updates. A reset updates the keys that you specify to the default configuration for the component. A merge updates the core device's component configuration with the keys and values that you specify. The IoT Greengrass Core software applies reset updates before it applies merge updates. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/update-component-configurations.html\">Update component configurations</a> in the <i>IoT Greengrass V2 Developer Guide</i>."
        }
      ]
    },
    "runWith": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ComponentRunWith"
        },
        {
          "description": "The system user and group that the IoT Greengrass Core software uses to run component processes on the core device. If you omit this parameter, the IoT Greengrass Core software uses the system user and group that you configure for the core device. For more information, see <a href=\"https://docs.aws.amazon.com/greengrass/v2/developerguide/configure-greengrass-core-v2.html#configure-component-user\">Configure the user and group that run components</a> in the <i>IoT Greengrass V2 Developer Guide</i>."
        }
      ]
    }
  }
}