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: "XmlStringMaxLen255", # 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,
  time_zone: "XmlStringMaxLen255",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#desired_capacityInteger

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain. It can scale beyond this capacity if you add more scaling conditions.

Returns:

  • (Integer)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#end_timeTime

The date and time for the recurring schedule to end, in UTC.

Returns:

  • (Time)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#max_sizeInteger

The maximum size of the Auto Scaling group.

Returns:

  • (Integer)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#min_sizeInteger

The minimum size of the Auto Scaling group.

Returns:

  • (Integer)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#recurrenceString

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

Cron expressions use Universal Coordinated Time (UTC) by default.

Returns:

  • (String)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#scheduled_action_nameString

The name of this scaling action.

Returns:

  • (String)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

class PutScheduledUpdateGroupActionType < Struct.new(
  :auto_scaling_group_name,
  :scheduled_action_name,
  :time,
  :start_time,
  :end_time,
  :recurrence,
  :min_size,
  :max_size,
  :desired_capacity,
  :time_zone)
  SENSITIVE = []
  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)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#timeTime

This parameter is no longer used.

Returns:

  • (Time)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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

#time_zoneString

Specifies the time zone for a cron expression. If a time zone is not provided, UTC is used by default.

Valid values are the canonical names of the IANA time zones, derived from the IANA Time Zone Database (such as Etc/GMT+9 or Pacific/Tahiti). For more information, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

Returns:

  • (String)


7235
7236
7237
7238
7239
7240
7241
7242
7243
7244
7245
7246
7247
7248
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7235

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