PutWarmPoolType

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/amazon-ec2-auto-scaling/refs/heads/main/json-schema/ec2-auto-scaling-put-warm-pool-type-schema.json",
  "title": "PutWarmPoolType",
  "description": "PutWarmPoolType schema from Auto Scaling",
  "type": "object",
  "properties": {
    "AutoScalingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of the Auto Scaling group."
        }
      ]
    },
    "MaxGroupPreparedCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MaxGroupPreparedCapacity"
        },
        {
          "description": "<p>Specifies the maximum number of instances that are allowed to be in the warm pool or in any state except <code>Terminated</code> for the Auto Scaling group. This is an optional property. Specify it only if you do not want the warm pool size to be determined by the difference between the group's maximum capacity and its desired capacity. </p> <important> <p>If a value for <code>MaxGroupPreparedCapacity</code> is not specified, Amazon EC2 Auto Scaling launches and maintains the difference between the group's maximum capacity and its desired capacity. If you specify a value for <code>MaxGroupPreparedCapacity</code>, Amazon EC2 Auto Scaling uses the difference between the <code>MaxGroupPreparedCapacity</code> and the desired capacity instead. </p> <p>The size of the warm pool is dynamic. Only when <code>MaxGroupPreparedCapacity</code> and <code>MinSize</code> are set to the same value does the warm pool have an absolute size.</p> </important> <p>If the desired capacity of the Auto Scaling group is higher than the <code>MaxGroupPreparedCapacity</code>, the capacity of the warm pool is 0, unless you specify a value for <code>MinSize</code>. To remove a value that you previously set, include the property but specify -1 for the value. </p>"
        }
      ]
    },
    "MinSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WarmPoolMinSize"
        },
        {
          "description": "Specifies the minimum number of instances to maintain in the warm pool. This helps you to ensure that there is always a certain number of warmed instances available to handle traffic spikes. Defaults to 0 if not specified."
        }
      ]
    },
    "PoolState": {
      "allOf": [
        {
          "$ref": "#/components/schemas/WarmPoolState"
        },
        {
          "description": "Sets the instance state to transition to after the lifecycle actions are complete. Default is <code>Stopped</code>."
        }
      ]
    },
    "InstanceReusePolicy": {
      "allOf": [
        {
          "$ref": "#/components/schemas/InstanceReusePolicy"
        },
        {
          "description": "Indicates whether instances in the Auto Scaling group can be returned to the warm pool on scale in. The default is to terminate instances in the Auto Scaling group when the group scales in."
        }
      ]
    }
  },
  "required": [
    "AutoScalingGroupName"
  ]
}