ExecutePolicyType

{
  "$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-execute-policy-type-schema.json",
  "title": "ExecutePolicyType",
  "description": "ExecutePolicyType schema from Auto Scaling",
  "type": "object",
  "properties": {
    "AutoScalingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of the Auto Scaling group."
        }
      ]
    },
    "PolicyName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/ResourceName"
        },
        {
          "description": "The name or ARN of the policy."
        }
      ]
    },
    "HonorCooldown": {
      "allOf": [
        {
          "$ref": "#/components/schemas/HonorCooldown"
        },
        {
          "description": "<p>Indicates whether Amazon EC2 Auto Scaling waits for the cooldown period to complete before executing the policy.</p> <p>Valid only if the policy type is <code>SimpleScaling</code>. For more information, see <a href=\"https://docs.aws.amazon.com/autoscaling/ec2/userguide/Cooldown.html\">Scaling cooldowns for Amazon EC2 Auto Scaling</a> in the <i>Amazon EC2 Auto Scaling User Guide</i>.</p>"
        }
      ]
    },
    "MetricValue": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricScale"
        },
        {
          "description": "<p>The metric value to compare to <code>BreachThreshold</code>. This enables you to execute a policy of type <code>StepScaling</code> and determine which step adjustment to use. For example, if the breach threshold is 50 and you want to use a step adjustment with a lower bound of 0 and an upper bound of 10, you can set the metric value to 59.</p> <p>If you specify a metric value that doesn't correspond to a step adjustment for the policy, the call returns an error.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
        }
      ]
    },
    "BreachThreshold": {
      "allOf": [
        {
          "$ref": "#/components/schemas/MetricScale"
        },
        {
          "description": "<p>The breach threshold for the alarm.</p> <p>Required if the policy type is <code>StepScaling</code> and not supported otherwise.</p>"
        }
      ]
    }
  },
  "required": [
    "PolicyName"
  ]
}