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

Class: Aws::AutoScaling::Types::SetDesiredCapacityType

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 SetDesiredCapacityType data as a hash:

{
  auto_scaling_group_name: "ResourceName", # required
  desired_capacity: 1, # required
  honor_cooldown: false,
}

Contains the parameters for SetDesiredCapacity.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


3729
3730
3731
3732
3733
3734
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3729

class SetDesiredCapacityType < Struct.new(
  :auto_scaling_group_name,
  :desired_capacity,
  :honor_cooldown)
  include Aws::Structure
end

#desired_capacityInteger

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

Returns:

  • (Integer)


3729
3730
3731
3732
3733
3734
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3729

class SetDesiredCapacityType < Struct.new(
  :auto_scaling_group_name,
  :desired_capacity,
  :honor_cooldown)
  include Aws::Structure
end

#honor_cooldownBoolean

By default, SetDesiredCapacity overrides any cooldown period associated with the Auto Scaling group. Specify True to make Auto Scaling to wait for the cool-down period associated with the Auto Scaling group to complete before initiating a scaling activity to set your Auto Scaling group to its new capacity.

Returns:

  • (Boolean)


3729
3730
3731
3732
3733
3734
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3729

class SetDesiredCapacityType < Struct.new(
  :auto_scaling_group_name,
  :desired_capacity,
  :honor_cooldown)
  include Aws::Structure
end