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

Class: Aws::AutoScaling::Types::PutScheduledUpdateGroupActionType

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 PutScheduledUpdateGroupActionType data as a hash:

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

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#desired_capacityInteger

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

Returns:

  • (Integer)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

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


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#max_sizeInteger

The maximum number of instances in the Auto Scaling group.

Returns:

  • (Integer)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#min_sizeInteger

The minimum number of instances in the Auto Scaling group.

Returns:

  • (Integer)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#recurrenceString

The recurring schedule for this 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)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#scheduled_action_nameString

The name of this scaling action.

Returns:

  • (String)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#start_timeTime

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, "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 your action in the past, Amazon EC2 Auto Scaling returns an error message.

Returns:

  • (Time)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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

#timeTime

This parameter is no longer used.

Returns:

  • (Time)


4242
4243
4244
4245
4246
4247
4248
4249
4250
4251
4252
4253
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 4242

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