HealthCheckCustomConfig class

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.
To change the status of a custom health check, submit an UpdateInstanceCustomHealthStatus request. AWS 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.
  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.

Constructors

HealthCheckCustomConfig({int? failureThreshold})
HealthCheckCustomConfig.fromJson(Map<String, dynamic> json)
factory

Properties

failureThreshold → int?
UpdateInstanceCustomHealthStatus
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited