Package software.amazon.awssdk.services.vpclattice.model

Class HealthCheckConfig

java.lang.Object
software.amazon.awssdk.services.vpclattice.model.HealthCheckConfig
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
@Generated("software.amazon.awssdk:codegen") public final class HealthCheckConfig extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>

The health check configuration of a target group. Health check configurations aren't used for LAMBDA and ALB target groups.

See Also:

  • Method Details

    • enabled

      public final Boolean enabled()

      Indicates whether health checking is enabled.

      Returns:
      Indicates whether health checking is enabled.

    • healthCheckIntervalSeconds

      public final Integer healthCheckIntervalSeconds()

      The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

      Returns:
      The approximate amount of time, in seconds, between health checks of an individual target. The range is 5–300 seconds. The default is 30 seconds.

    • healthCheckTimeoutSeconds

      public final Integer healthCheckTimeoutSeconds()

      The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

      Returns:
      The amount of time, in seconds, to wait before reporting a target as unhealthy. The range is 1–120 seconds. The default is 5 seconds.

    • healthyThresholdCount

      public final Integer healthyThresholdCount()

      The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

      Returns:
      The number of consecutive successful health checks required before considering an unhealthy target healthy. The range is 2–10. The default is 5.

    • matcher

      public final Matcher matcher()

      The codes to use when checking for a successful response from a target. These are called Success codes in the console.

      Returns:
      The codes to use when checking for a successful response from a target. These are called Success codes in the console.

    • path

      public final String path()

      The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

      Returns:
      The destination for health checks on the targets. If the protocol version is HTTP/1.1 or HTTP/2, specify a valid URI (for example, /path?query). The default path is /. Health checks are not supported if the protocol version is gRPC, however, you can choose HTTP/1.1 or HTTP/2 and specify a valid URI.

    • port

      public final Integer port()

      The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

      Returns:
      The port used when performing health checks on targets. The default setting is the port that a target receives traffic on.

    • protocol

      public final TargetGroupProtocol protocol()

      The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

      If the service returns an enum value that is not available in the current SDK version, protocol will return TargetGroupProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
      See Also:

    • protocolAsString

      public final String protocolAsString()

      The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.

      If the service returns an enum value that is not available in the current SDK version, protocol will return TargetGroupProtocol.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolAsString().

      Returns:
      The protocol used when performing health checks on targets. The possible protocols are HTTP and HTTPS. The default is HTTP.
      See Also:

    • protocolVersion

      public final HealthCheckProtocolVersion protocolVersion()

      The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

      If the service returns an enum value that is not available in the current SDK version, protocolVersion will return HealthCheckProtocolVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolVersionAsString().

      Returns:
      The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
      See Also:

    • protocolVersionAsString

      public final String protocolVersionAsString()

      The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.

      If the service returns an enum value that is not available in the current SDK version, protocolVersion will return HealthCheckProtocolVersion.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from protocolVersionAsString().

      Returns:
      The protocol version used when performing health checks on targets. The possible protocol versions are HTTP1 and HTTP2.
      See Also:

    • unhealthyThresholdCount

      public final Integer unhealthyThresholdCount()

      The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

      Returns:
      The number of consecutive failed health checks required before considering a target unhealthy. The range is 2–10. The default is 2.

    • toBuilder

      public HealthCheckConfig.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<HealthCheckConfig.Builder,HealthCheckConfig>
      Returns:
      a builder for type T

    • builder

      public static HealthCheckConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends HealthCheckConfig.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • 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.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.