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

Class: Aws::AutoScaling::ScheduledAction

Inherits:
Resources::Resource show all
Defined in:
(unknown)

Instance Attribute Summary collapse

Attributes inherited from Resources::Resource

#client, #identifiers

Instance Method Summary collapse

Methods inherited from Resources::Resource

add_data_attribute, add_identifier, #data, data_attributes, #data_loaded?, identifiers, #load, #wait_until

Methods included from Resources::OperationMethods

#add_batch_operation, #add_operation, #batch_operation, #batch_operation_names, #batch_operations, #operation, #operation_names, #operations

Constructor Details

#initialize(name, options = {}) ⇒ Object #initialize(options = {}) ⇒ Object

Overloads:

  • #initialize(name, options = {}) ⇒ Object

    Parameters:

    • name (String)

    Options Hash (options):

    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

  • #initialize(options = {}) ⇒ Object

    Options Hash (options):

    • :name (required, String)
    • :client (Client) —

      When `:client is not given, the options hash is used to construct a new Client object.

Instance Attribute Details

#auto_scaling_group_name ⇒ String (readonly)

The name of the Auto Scaling group.

Returns:

  • (String) —

    The name of the Auto Scaling group.

#desired_capacity ⇒ Integer (readonly)

The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

Returns:

  • (Integer) —

    The desired capacity is the initial capacity of the Auto Scaling group after the scheduled action runs and the capacity it attempts to maintain.

#end_time ⇒ Time (readonly)

The date and time in UTC for the recurring schedule to end. For example, "2019-06-01T00:00:00Z".

Returns:

  • (Time) —

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

#max_size ⇒ Integer (readonly)

The maximum size of the Auto Scaling group.

Returns:

  • (Integer) —

    The maximum size of the Auto Scaling group.

#min_size ⇒ Integer (readonly)

The minimum size of the Auto Scaling group.

Returns:

  • (Integer) —

    The minimum size of the Auto Scaling group.

#name ⇒ String (readonly)

Returns:

  • (String)

#recurrence ⇒ String (readonly)

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

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action starts and stops.

Returns:

  • (String) —

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

#scheduled_action_arn ⇒ String (readonly)

The Amazon Resource Name (ARN) of the scheduled action.

Returns:

  • (String) —

    The Amazon Resource Name (ARN) of the scheduled action.

#scheduled_action_name ⇒ String (readonly)

The name of the scheduled action.

Returns:

  • (String) —

    The name of the scheduled action.

#start_time ⇒ Time (readonly)

The date and time in UTC for this action to start. For example, "2019-06-01T00:00:00Z".

Returns:

  • (Time) —

    The date and time in UTC for this action to start.

#time ⇒ Time (readonly)

This parameter is no longer used.

Returns:

  • (Time) —

    This parameter is no longer used.

Instance Method Details

#delete(options = {}) ⇒ Struct

Deletes the specified scheduled action.

Examples:

Request syntax example with placeholder values


scheduledaction.delete({
  auto_scaling_group_name: "ResourceName", # required
})

Options Hash (options):

  • :auto_scaling_group_name (required, String) —

    The name of the Auto Scaling group.

Returns:

  • (Struct) —

    Returns an empty response.

See Also:

#group ⇒ AutoScalingGroup?

Returns: