Amazon EC2 Auto Scaling · JSON Structure

Ec2 Auto Scaling Scheduled Update Group Action Request Structure

Describes information used for one or more scheduled scaling action updates in a BatchPutScheduledUpdateGroupAction operation.

Type: object Properties: 8 Required: 1
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

ScheduledUpdateGroupActionRequest is a JSON Structure definition published by Amazon EC2 Auto Scaling, describing 8 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

ScheduledActionName StartTime EndTime Recurrence MinSize MaxSize DesiredCapacity TimeZone

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-ec2-auto-scaling/refs/heads/main/json-structure/ec2-auto-scaling-scheduled-update-group-action-request-structure.json",
  "name": "ScheduledUpdateGroupActionRequest",
  "description": "Describes information used for one or more scheduled scaling action updates in a <a>BatchPutScheduledUpdateGroupAction</a> operation.",
  "type": "object",
  "properties": {
    "ScheduledActionName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of the scaling action."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimestampType"
        },
        {
          "description": "<p>The date and time for the action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, <code>\"2019-06-01T00:00:00Z\"</code>).</p> <p>If you specify <code>Recurrence</code> and <code>StartTime</code>, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.</p> <p>If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.</p>"
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimestampType"
        },
        {
          "description": "The date and time for the recurring schedule to end, in UTC."
        }
      ]
    },
    "Recurrence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "<p>The recurring schedule for the action, in Unix cron syntax format. This format consists of five fields separated by white spaces: [Minute] [Hour] [Day_of_Month] [Month_of_Year] [Day_of_Week]. The value must be in quotes (for example, <code>\"30 0 1 1,6,12 *\"</code>). For more information about this format, see <a href=\"http://crontab.org\">Crontab</a>.</p> <p>When <code>StartTime</code> and <code>EndTime</code> are specified with <code>Recurrence</code>, they form the boundaries of when the recurring action starts and stops.</p> <p>Cron expressions use Universal Coordinated Time (UTC) by default.</p>"
        }
      ]
    },
    "MinSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoScalingGroupMinSize"
        },
        {
          "description": "The minimum size of the Auto Scaling group."
        }
      ]
    },
    "MaxSize": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoScalingGroupMaxSize"
        },
        {
          "description": "The maximum size of the Auto Scaling group."
        }
      ]
    },
    "DesiredCapacity": {
      "allOf": [
        {
          "$ref": "#/components/schemas/AutoScalingGroupDesiredCapacity"
        },
        {
          "description": "The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain."
        }
      ]
    },
    "TimeZone": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "<p>Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default. </p> <p>Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as <code>Etc/GMT+9</code> or <code>Pacific/Tahiti</code>). For more information, see <a href=\"https://en.wikipedia.org/wiki/List_of_tz_database_time_zones\">https://en.wikipedia.org/wiki/List_of_tz_database_time_zones</a>.</p>"
        }
      ]
    }
  },
  "required": [
    "ScheduledActionName"
  ]
}