Class: Aws::AutoScaling::Types::SetInstanceHealthQuery

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-autoscaling/types.rb

Overview

Note:

When making an API call, you may pass SetInstanceHealthQuery data as a hash:

{
  instance_id: "XmlStringMaxLen19", # required
  health_status: "XmlStringMaxLen32", # required
  should_respect_grace_period: false,
}

Instance Attribute Summary collapse

Instance Attribute Details

#health_statusString

The health status of the instance. Set to ‘Healthy` to have the instance remain in service. Set to `Unhealthy` to have the instance be out of service. Amazon EC2 Auto Scaling terminates and replaces the unhealthy instance.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
# File 'lib/aws-sdk-autoscaling/types.rb', line 4257

class SetInstanceHealthQuery < Struct.new(
  :instance_id,
  :health_status,
  :should_respect_grace_period)
  include Aws::Structure
end

#instance_idString

The ID of the instance.

Returns:

  • (String)


4257
4258
4259
4260
4261
4262
# File 'lib/aws-sdk-autoscaling/types.rb', line 4257

class SetInstanceHealthQuery < Struct.new(
  :instance_id,
  :health_status,
  :should_respect_grace_period)
  include Aws::Structure
end

#should_respect_grace_periodBoolean

If the Auto Scaling group of the specified instance has a ‘HealthCheckGracePeriod` specified for the group, by default, this call respects the grace period. Set this to `False`, to have the call not respect the grace period associated with the group.

For more information about the health check grace period, see CreateAutoScalingGroup.

Returns:

  • (Boolean)


4257
4258
4259
4260
4261
4262
# File 'lib/aws-sdk-autoscaling/types.rb', line 4257

class SetInstanceHealthQuery < Struct.new(
  :instance_id,
  :health_status,
  :should_respect_grace_period)
  include Aws::Structure
end