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

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

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 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 if you want the instance to remain in service. Set to Unhealthy if you want the instance to be out of service. Auto Scaling will terminate and replace the unhealthy instance.

Returns:

  • (String)


3722
3723
3724
3725
3726
3727
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3722

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)


3722
3723
3724
3725
3726
3727
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3722

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 will respect the grace period. Set this to False, if you do not want the call to respect the grace period associated with the group.

For more information, see the description of the health check grace period for CreateAutoScalingGroup.

Returns:

  • (Boolean)


3722
3723
3724
3725
3726
3727
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 3722

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