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,
}

Constant Summary collapse

SENSITIVE =
[]

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)


7916
7917
7918
7919
7920
7921
7922
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7916

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

#instance_idString

The ID of the instance.

Returns:

  • (String)


7916
7917
7918
7919
7920
7921
7922
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7916

class SetInstanceHealthQuery < Struct.new(
  :instance_id,
  :health_status,
  :should_respect_grace_period)
  SENSITIVE = []
  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 in the Amazon EC2 Auto Scaling API Reference.

Returns:

  • (Boolean)


7916
7917
7918
7919
7920
7921
7922
# File 'gems/aws-sdk-autoscaling/lib/aws-sdk-autoscaling/types.rb', line 7916

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