UpdateEnvironmentRequest

UpdateEnvironmentRequest schema from AWS Mainframe Modernization API

COBOLMainframeMigrationModernizationBatch Processing

Properties

Name Type Description
applyDuringMaintenanceWindow object
desiredCapacity object
engineVersion object
instanceType object
preferredMaintenanceWindow object
View JSON Schema on GitHub

JSON Schema

amazon-mainframe-modernization-update-environment-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-mainframe-modernization/refs/heads/main/json-schema/amazon-mainframe-modernization-update-environment-request-schema.json",
  "title": "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."
        }
      ]
    }
  }
}