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 or Amazon Resource Name (ARN) of the Auto Scaling group.

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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 time for the recurring schedule to end. Auto Scaling does not perform the action after this time.

Returns:

  • (Time)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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 size for the Auto Scaling group.

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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 size for the Auto Scaling group.

Returns:

  • (Integer)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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. For more information, see Cron in Wikipedia.

Returns:

  • (String)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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 time for this action to start, in "YYYY-MM-DDThh:mm:ssZ" format in UTC/GMT only (for example, 2014-06-01T00:00:00Z).

If you specify Recurrence and StartTime, 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, Auto Scaling returns an error message.

Returns:

  • (Time)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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

Returns:

  • (Time)


3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3385

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