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

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass ScheduledUpdateGroupActionRequest data as a 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)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#end_timeTime

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

Returns:

  • (Time)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#max_sizeInteger

The maximum size of the group.

Returns:

  • (Integer)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#min_sizeInteger

The minimum size of the group.

Returns:

  • (Integer)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#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.

Returns:

  • (String)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#scheduled_action_nameString

The name of the scaling action.

Returns:

  • (String)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end

#start_timeTime

The 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)


4342
4343
4344
4345
4346
4347
4348
4349
4350
4351
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4342

class ScheduledUpdateGroupActionRequest < Struct.new(
  :scheduled_action_name,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity)
  include Aws::Structure
end