AutoScalingConfigurationSummary

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/oracle/main/json-schema/oracle-auto-scaling-configuration-summary-schema.json",
  "title": "AutoScalingConfigurationSummary",
  "description": "Summary information for an autoscaling configuration.\n",
  "x-generated": "2026-10-03",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/oracle-autoscaling-api-openapi.yml#/components/schemas/AutoScalingConfigurationSummary",
  "properties": {
    "compartmentId": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the compartment containing the autoscaling configuration.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "coolDownInSeconds": {
      "description": "For threshold-based autoscaling policies, this value is the minimum period of time to wait between scaling actions.\nThe cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which\nis also the default. The cooldown period starts when the instance pool reaches the running state.\n\nFor schedule-based autoscaling policies, this value is not used.\n",
      "minimum": 0,
      "type": "integer"
    },
    "definedTags": {
      "additionalProperties": {
        "additionalProperties": {
          "description": "The value of the tag. Only the String type is supported.\n",
          "type": "object"
        },
        "description": "Key-value pair representing a defined tag key and value, scoped to a namespace.\n\nExample: `{\"CostCenter\": \"42\"}`\n",
        "type": "object"
      },
      "description": "Defined tags for this resource. Each key is predefined and scoped to a\nnamespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Operations\": {\"CostCenter\": \"42\"}}`\n",
      "type": "object"
    },
    "displayName": {
      "description": "A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.\n",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "freeformTags": {
      "additionalProperties": {
        "type": "string"
      },
      "description": "Free-form tags for this resource. Each tag is a simple key-value pair with no\npredefined name, type, or namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).\n\nExample: `{\"Department\": \"Finance\"}`\n",
      "type": "object"
    },
    "id": {
      "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the autoscaling configuration.",
      "maxLength": 255,
      "minLength": 1,
      "type": "string"
    },
    "isEnabled": {
      "description": "Whether the autoscaling configuration is enabled.",
      "type": "boolean"
    },
    "resource": {
      "$ref": "#/$defs/Resource"
    },
    "timeCreated": {
      "description": "The date and time the autoscaling configuration was created, in the format defined by RFC3339.\n\nExample: `2016-08-25T21:10:29.600Z`\n",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "compartmentId",
    "id",
    "resource",
    "timeCreated"
  ],
  "type": "object",
  "x-example": "{\n  \"compartmentId\": \"ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"displayName\": \"example_autoscaling_configuration\",\n  \"id\": \"ocid1.autoscalingconfiguration.oc1..<var>&lt;unique_ID&gt;</var>\",\n  \"coolDownInSeconds\": 300,\n  \"isEnabled\": true,\n  \"resource\": {\n    \"type\": \"instancePool\",\n    \"id\": \"ocid1.instancepool.oc1..<var>&lt;unique_ID&gt;</var>\"\n  },\n  \"timeCreated\": \"2019-01-18T18:44:45.285Z\"\n}\n",
  "$defs": {
    "Resource": {
      "description": "A resource that is managed by an autoscaling configuration. The only supported type is `instancePool`.\n\nEach instance pool can have one autoscaling configuration.\n",
      "properties": {
        "id": {
          "description": "The [OCID](/Content/General/Concepts/identifiers.htm) of the resource that is managed by the autoscaling configuration.\n",
          "maxLength": 255,
          "minLength": 1,
          "type": "string"
        },
        "type": {
          "description": "The type of resource.",
          "maxLength": 100,
          "minLength": 1,
          "type": "string"
        }
      },
      "required": [
        "type",
        "id"
      ]
    }
  }
}