Incident Manager Ssm Automation Structure

{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-incident-manager/refs/heads/main/json-structure/incident-manager-ssm-automation-structure.json",
  "name": "SsmAutomation",
  "description": "Details about the Systems Manager automation document that will be used as a runbook during an incident.",
  "type": "object",
  "properties": {
    "documentName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SsmAutomationDocumentNameString"
        },
        {
          "description": "The automation document's name."
        }
      ]
    },
    "documentVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SsmAutomationDocumentVersionString"
        },
        {
          "description": "The automation document's version to use when running."
        }
      ]
    },
    "dynamicParameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/DynamicSsmParameters"
        },
        {
          "description": "The key-value pair to resolve dynamic parameter values when processing a Systems Manager Automation runbook."
        }
      ]
    },
    "parameters": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SsmParameters"
        },
        {
          "description": "The key-value pair parameters to use when running the automation document."
        }
      ]
    },
    "roleArn": {
      "allOf": [
        {
          "$ref": "#/components/schemas/RoleArn"
        },
        {
          "description": "The Amazon Resource Name (ARN) of the role that the automation document will assume when running commands."
        }
      ]
    },
    "targetAccount": {
      "allOf": [
        {
          "$ref": "#/components/schemas/SsmTargetAccount"
        },
        {
          "description": "The account that the automation document will be run in. This can be in either the management account or an application account."
        }
      ]
    }
  },
  "required": [
    "documentName",
    "roleArn"
  ]
}