Class ContainerServiceHealthCheckConfig

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

Describes the health check configuration of an Amazon Lightsail container service.

See Also:

  • Method Details

    • healthyThreshold

      public final Integer healthyThreshold()

      The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

      Returns:
      The number of consecutive health checks successes required before moving the container to the Healthy state. The default value is 2.

    • unhealthyThreshold

      public final Integer unhealthyThreshold()

      The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

      Returns:
      The number of consecutive health check failures required before moving the container to the Unhealthy state. The default value is 2.

    • timeoutSeconds

      public final Integer timeoutSeconds()

      The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

      Returns:
      The amount of time, in seconds, during which no response means a failed health check. You can specify between 2 and 60 seconds. The default value is 2.

    • intervalSeconds

      public final Integer intervalSeconds()

      The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

      Returns:
      The approximate interval, in seconds, between health checks of an individual container. You can specify between 5 and 300 seconds. The default value is 5.

    • path

      public final String path()

      The path on the container on which to perform the health check. The default value is /.

      Returns:
      The path on the container on which to perform the health check. The default value is /.

    • successCodes

      public final String successCodes()

      The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

      Returns:
      The HTTP codes to use when checking for a successful response from a container. You can specify values between 200 and 499. You can specify multiple values (for example, 200,202) or a range of values (for example, 200-299).

    • toBuilder

      public ContainerServiceHealthCheckConfig.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<ContainerServiceHealthCheckConfig.Builder,ContainerServiceHealthCheckConfig>
      Returns:
      a builder for type T

    • builder

      public static ContainerServiceHealthCheckConfig.Builder builder()

    • serializableBuilderClass

      public static Class<? extends ContainerServiceHealthCheckConfig.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.