You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AutoScaling::Types::ScheduledUpdateGroupActionRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing ScheduledUpdateGroupActionRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  scheduled_action_name: "XmlStringMaxLen255", # required
  start_time: Time.now,
  end_time: Time.now,
  recurrence: "XmlStringMaxLen255",
  min_size: 1,
  max_size: 1,
  desired_capacity: 1,
}

Describes one or more scheduled scaling action updates for a specified Auto Scaling group. Used in combination with BatchPutScheduledUpdateGroupAction.

When updating a scheduled scaling action, all optional parameters are left unchanged if not specified.

Instance Attribute Summary collapse

Instance Attribute Details

#desired_capacityInteger

The number of EC2 instances that should be running in the group.

Returns:

  • (Integer)

    The number of EC2 instances that should be running in the group.

#end_timeTime

The date and time for the recurring schedule to end. Amazon EC2 Auto Scaling does not perform the action after this time.

Returns:

  • (Time)

    The date and time for the recurring schedule to end.

#max_sizeInteger

The maximum number of instances in the Auto Scaling group.

Returns:

  • (Integer)

    The maximum number of instances in the Auto Scaling group.

#min_sizeInteger

The minimum number of instances in the Auto Scaling group.

Returns:

  • (Integer)

    The minimum number of instances in the Auto Scaling group.

#recurrenceString

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, "30 0 1 1,6,12 *"). For more information about this format, see Crontab.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

Returns:

  • (String)

    The recurring schedule for the action, in Unix cron syntax format.

#scheduled_action_nameString

The name of the scaling action.

Returns:

  • (String)

    The name of the scaling action.

#start_timeTime

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, "2019-06-01T00:00:00Z").

If you specify Recurrence and StartTime, Amazon EC2 Auto Scaling performs the action at this time, and then performs the action based on the specified recurrence.

If you try to schedule the action in the past, Amazon EC2 Auto Scaling returns an error message.

Returns:

  • (Time)

    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, "2019-06-01T00:00:00Z").