Amazon EC2 Auto Scaling · JSON Structure

Ec2 Auto Scaling Put Scheduled Update Group Action Type Structure

PutScheduledUpdateGroupActionType schema from Auto Scaling

Type: object Properties: 10 Required: 2
Amazon Web ServicesAuto ScalingComputeEC2High AvailabilityScaling

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

Properties

AutoScalingGroupName ScheduledActionName Time 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-put-scheduled-update-group-action-type-structure.json",
  "name": "PutScheduledUpdateGroupActionType",
  "description": "PutScheduledUpdateGroupActionType schema from Auto Scaling",
  "type": "object",
  "properties": {
    "AutoScalingGroupName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of the Auto Scaling group."
        }
      ]
    },
    "ScheduledActionName": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "The name of this scaling action."
        }
      ]
    },
    "Time": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimestampType"
        },
        {
          "description": "This property is no longer used."
        }
      ]
    },
    "StartTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimestampType"
        },
        {
          "description": "<p>The date and time for this action to start, in YYYY-MM-DDThh:mm:ssZ format in UTC/GMT only and in quotes (for example, <code>\"2021-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>"
        }
      ]
    },
    "EndTime": {
      "allOf": [
        {
          "$ref": "#/components/schemas/TimestampType"
        },
        {
          "description": "The date and time for the recurring schedule to end, in UTC. For example, <code>\"2021-06-01T00:00:00Z\"</code>."
        }
      ]
    },
    "Recurrence": {
      "allOf": [
        {
          "$ref": "#/components/schemas/XmlStringMaxLen255"
        },
        {
          "description": "<p>The recurring schedule for this action. 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": "<p>The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions. </p> <note> <p>You must specify at least one of the following properties: <code>MaxSize</code>, <code>MinSize</code>, or <code>DesiredCapacity</code>. </p> </note>"
        }
      ]
    },
    "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": [
    "AutoScalingGroupName",
    "ScheduledActionName"
  ]
}