Class: Aws::ServiceDiscovery::Types::HealthCheckCustomConfig

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

Overview

Note:

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

{
  failure_threshold: 1,
}

A complex type that contains information about an optional custom health check. A custom health check, which requires that you use a third-party health checker to evaluate the health of your resources, is useful in the following circumstances:

  • You can’t use a health check that is defined by ‘HealthCheckConfig` because the resource isn’t available over the internet. For example, you can use a custom health check when the instance is in an Amazon VPC. (To check the health of resources in a VPC, the health checker must also be in the VPC.)

  • You want to use a third-party health checker regardless of where your resources are.

If you specify a health check configuration, you can specify either ‘HealthCheckCustomConfig` or `HealthCheckConfig` but not both.

To change the status of a custom health check, submit an ‘UpdateInstanceCustomHealthStatus` request. Cloud Map doesn’t monitor the status of the resource, it just keeps a record of the status specified in the most recent ‘UpdateInstanceCustomHealthStatus` request.

Here’s how custom health checks work:

  1. You create a service and specify a value for ‘FailureThreshold`.

    The failure threshold indicates the number of 30-second intervals you want AWS Cloud Map to wait between the time that your application sends an UpdateInstanceCustomHealthStatus request and the time that AWS Cloud Map stops routing internet traffic to the corresponding resource.

  2. You register an instance.

  3. You configure a third-party health checker to monitor the resource that is associated with the new instance.

    <note markdown=“1”> AWS Cloud Map doesn’t check the health of the resource directly.

    </note>

  4. The third-party health-checker determines that the resource is unhealthy and notifies your application.

  5. Your application submits an ‘UpdateInstanceCustomHealthStatus` request.

  6. AWS Cloud Map waits for (‘FailureThreshold` x 30) seconds.

  7. If another ‘UpdateInstanceCustomHealthStatus` request doesn’t arrive during that time to change the status back to healthy, AWS Cloud Map stops routing traffic to the resource.

Note the following about configuring custom health checks.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#failure_threshold ⇒ Integer

The number of 30-second intervals that you want Cloud Map to wait after receiving an ‘UpdateInstanceCustomHealthStatus` request before it changes the health status of a service instance. For example, suppose you specify a value of `2` for `FailureTheshold`, and then your application sends an `UpdateInstanceCustomHealthStatus` request. Cloud Map waits for approximately 60 seconds (2 x 30) before changing the status of the service instance based on that request.

Sending a second or subsequent ‘UpdateInstanceCustomHealthStatus` request with the same value before `FailureThreshold x 30` seconds has passed doesn’t accelerate the change. Cloud Map still waits ‘FailureThreshold x 30` seconds after the first request to make the change.

Returns:

  • (Integer) 


1106
1107
1108
1109
 
# File 'lib/aws-sdk-servicediscovery/types.rb', line 1106

class HealthCheckCustomConfig < Struct.new(
  :failure_threshold)
  include Aws::Structure
end