Class HealthCheckCustomConfig
- java.lang.Object
-
- software.amazon.awssdk.services.servicediscovery.model.HealthCheckCustomConfig
-
- All Implemented Interfaces:
Serializable
,SdkPojo
,ToCopyableBuilder<HealthCheckCustomConfig.Builder,HealthCheckCustomConfig>
@Generated("software.amazon.awssdk:codegen") public final class HealthCheckCustomConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheckCustomConfig.Builder,HealthCheckCustomConfig>
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's 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 located.
If you specify a health check configuration, you can specify either
HealthCheckCustomConfig
orHealthCheckConfig
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 recentUpdateInstanceCustomHealthStatus
request.Here's how custom health checks work:
-
You create a service.
-
You register an instance.
-
You configure a third-party health checker to monitor the resource that's associated with the new instance.
Cloud Map doesn't check the health of the resource directly.
-
The third-party health-checker determines that the resource is unhealthy and notifies your application.
-
Your application submits an
UpdateInstanceCustomHealthStatus
request. -
Cloud Map waits for 30 seconds.
-
If another
UpdateInstanceCustomHealthStatus
request doesn't arrive during that time to change the status back to healthy, Cloud Map stops routing traffic to the resource.
- See Also:
- Serialized Form
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
HealthCheckCustomConfig.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description static HealthCheckCustomConfig.Builder
builder()
boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
Integer
failureThreshold()
Deprecated.Configurable FailureThreshold of HealthCheckCustomConfig is deprecated.<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
List<SdkField<?>>
sdkFields()
static Class<? extends HealthCheckCustomConfig.Builder>
serializableBuilderClass()
HealthCheckCustomConfig.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
failureThreshold
@Deprecated public final Integer failureThreshold()
Deprecated.Configurable FailureThreshold of HealthCheckCustomConfig is deprecated. It will always have value 1.This parameter is no longer supported and is always set to 1. 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 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. Cloud Map still waits30
seconds after the first request to make the change.- Returns:
This parameter is no longer supported and is always set to 1. 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 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. Cloud Map still waits30
seconds after the first request to make the change.
-
toBuilder
public HealthCheckCustomConfig.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<HealthCheckCustomConfig.Builder,HealthCheckCustomConfig>
-
builder
public static HealthCheckCustomConfig.Builder builder()
-
serializableBuilderClass
public static Class<? extends HealthCheckCustomConfig.Builder> serializableBuilderClass()
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
-