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

Class: Aws::AutoScaling::Types::DetachInstancesQuery

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

{
  instance_ids: ["XmlStringMaxLen19"],
  auto_scaling_group_name: "ResourceName", # required
  should_decrement_desired_capacity: false, # required
}

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1872

class DetachInstancesQuery < Struct.new(
  :instance_ids,
  :auto_scaling_group_name,
  :should_decrement_desired_capacity)
  include Aws::Structure
end

#instance_idsArray<String>

One or more instance IDs.

Returns:

  • (Array<String>)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1872

class DetachInstancesQuery < Struct.new(
  :instance_ids,
  :auto_scaling_group_name,
  :should_decrement_desired_capacity)
  include Aws::Structure
end

#should_decrement_desired_capacityBoolean

If True, the Auto Scaling group decrements the desired capacity value by the number of instances detached.

Returns:

  • (Boolean)


1872
1873
1874
1875
1876
1877
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 1872

class DetachInstancesQuery < Struct.new(
  :instance_ids,
  :auto_scaling_group_name,
  :should_decrement_desired_capacity)
  include Aws::Structure
end