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_nameString (readonly)

The name of the Auto Scaling group.

Returns:

  • (String)

    The name of the Auto Scaling group.

#desired_capacityInteger (readonly)

The number of instances you prefer to maintain in the group.

Returns:

  • (Integer)

    The number of instances you prefer to maintain in the group.

#end_timeTime (readonly)

The date and time that the action is scheduled to end. This date and time can be up to one month in the future.

Returns:

  • (Time)

    The date and time that the action is scheduled to end.

#max_sizeInteger (readonly)

The maximum size of the group.

Returns:

  • (Integer)

    The maximum size of the group.

#min_sizeInteger (readonly)

The minimum size of the group.

Returns:

  • (Integer)

    The minimum size of the group.

#nameString (readonly)

Returns:

  • (String)

#recurrenceString (readonly)

The recurring schedule for the action.

Returns:

  • (String)

    The recurring schedule for the action.

#scheduled_action_arnString (readonly)

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

Returns:

  • (String)

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

#scheduled_action_nameString (readonly)

The name of the scheduled action.

Returns:

  • (String)

    The name of the scheduled action.

#start_timeTime (readonly)

The date and time that the action is scheduled to begin. This date and time can be up to one month in the future.

When StartTime and EndTime are specified with Recurrence, they form the boundaries of when the recurring action will start and stop.

Returns:

  • (Time)

    The date and time that the action is scheduled to begin.

#timeTime (readonly)

This parameter is deprecated.

Returns:

  • (Time)

    This parameter is deprecated.

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:

#groupAutoScalingGroup?

Returns: