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

Class: Aws::AutoScaling::Types::EnterStandbyQuery

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

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

Contains the parameters for EnteStandby.

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_nameString

The name of the Auto Scaling group.

Returns:

  • (String)


2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2224

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

#instance_idsArray<String>

One or more instances to move into Standby mode. You must specify at least one instance ID.

Returns:

  • (Array<String>)


2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2224

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

#should_decrement_desired_capacityBoolean

Specifies whether the instances moved to Standby mode count as part of the Auto Scaling group's desired capacity. If set, the desired capacity for the Auto Scaling group decrements by the number of instances moved to Standby mode.

Returns:

  • (Boolean)


2224
2225
2226
2227
2228
2229
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 2224

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