Class CfnService.HealthCheckCustomConfigProperty
A complex type that contains information about an optional custom health check.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ServiceDiscovery
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HealthCheckCustomConfigProperty : Object, CfnService.IHealthCheckCustomConfigProperty
Syntax (vb)
Public Class HealthCheckCustomConfigProperty
Inherits Object
Implements CfnService.IHealthCheckCustomConfigProperty
Remarks
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:
If you specify a health check configuration, you can specify either <code>HealthCheckCustomConfig</code> or <code>HealthCheckConfig</code> but not both.
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:
AWS Cloud Map doesn't check the health of the resource directly.
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.ServiceDiscovery;
var healthCheckCustomConfigProperty = new HealthCheckCustomConfigProperty {
FailureThreshold = 123
};
Synopsis
Constructors
HealthCheckCustomConfigProperty() |
Properties
FailureThreshold | This parameter is no longer supported and is always set to 1. |
Constructors
HealthCheckCustomConfigProperty()
public HealthCheckCustomConfigProperty()
Properties
FailureThreshold
This parameter is no longer supported and is always set to 1.
public Nullable<double> FailureThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
AWS Cloud Map waits for approximately 30 seconds after receiving an UpdateInstanceCustomHealthStatus
request before changing the status of the service instance.
The number of 30-second intervals that you want AWS Cloud Map to wait after receiving an UpdateInstanceCustomHealthStatus
request before it changes the health status of a service instance.
Sending a second or subsequent UpdateInstanceCustomHealthStatus
request with the same value before 30 seconds has passed doesn't accelerate the change. AWS Cloud Map still waits 30
seconds after the first request to make the change.