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

Inherits:

Struct

• Object
• Struct
• Aws::AutoScaling::Types::PutScheduledUpdateGroupActionType

Includes:

Structure

Defined in:

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,
}

See Also:

• AWS API Documentation

Instance Attribute Summary

• #auto_scaling_group_name ⇒ String

  The name of the Auto Scaling group.

• #desired_capacity ⇒ Integer

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

• #end_time ⇒ Time

  The time for the recurring schedule to end.

• #max_size ⇒ Integer

  The maximum size for the Auto Scaling group.

• #min_size ⇒ Integer

  The minimum size for the Auto Scaling group.

• #recurrence ⇒ String

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

• #scheduled_action_name ⇒ String

  The name of this scaling action.

• #start_time ⇒ Time

  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`).

• #time ⇒ Time

  This parameter is deprecated.

Instance Attribute Details

#auto_scaling_group_name ⇒ String

The name of the Auto Scaling group.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_capacity ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_time ⇒ Time

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

Returns:

• (Time)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_size ⇒ Integer

The maximum size for the Auto Scaling group.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_size ⇒ Integer

The minimum size for the Auto Scaling group.

Returns:

• (Integer)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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

#recurrence ⇒ String

The recurring schedule for this action, in Unix cron syntax format. For more information about this format, see [Crontab].

[1]: crontab.org

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_name ⇒ String

The name of this scaling action.

Returns:

• (String)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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_time ⇒ Time

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`, 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)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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

#time ⇒ Time

This parameter is deprecated.

Returns:

• (Time)

# File 'lib/aws-sdk-autoscaling/types.rb', line 3847

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