Amazon Mainframe Modernization · JSON Structure

Amazon Mainframe Modernization Update Environment Request Structure

UpdateEnvironmentRequest schema from AWS Mainframe Modernization API

Type: object Properties: 5
COBOLMainframeMigrationModernizationBatch Processing

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

Properties

applyDuringMaintenanceWindow desiredCapacity engineVersion instanceType preferredMaintenanceWindow

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-mainframe-modernization/refs/heads/main/json-structure/amazon-mainframe-modernization-update-environment-request-structure.json",
  "name": "UpdateEnvironmentRequest",
  "description": "UpdateEnvironmentRequest schema from AWS Mainframe Modernization API",
  "type": "object",
  "properties": {
    "applyDuringMaintenanceWindow": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Boolean"
        },
        {
          "description": "Indicates whether to update the runtime environment during the maintenance window. The default is false. Currently, Amazon Web Services Mainframe Modernization accepts the <code>engineVersion</code> parameter only if <code>applyDuringMaintenanceWindow</code> is true. If any parameter other than <code>engineVersion</code> is provided in <code>UpdateEnvironmentRequest</code>, it will fail if <code>applyDuringMaintenanceWindow</code> is set to true."
        }
      ]
    },
    "desiredCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/CapacityValue"
        },
        {
          "description": "The desired capacity for the runtime environment to update. The minimum possible value is 0 and the maximum is 100."
        }
      ]
    },
    "engineVersion": {
      "allOf": [
        {
          "$ref": "#/components/schemas/EngineVersion"
        },
        {
          "description": "The version of the runtime engine for the runtime environment."
        }
      ]
    },
    "instanceType": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String20"
        },
        {
          "description": "The instance type for the runtime environment to update."
        }
      ]
    },
    "preferredMaintenanceWindow": {
      "allOf": [
        {
          "$ref": "#/components/schemas/String"
        },
        {
          "description": "Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned."
        }
      ]
    }
  }
}