Class ContainerHealthCheck

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

Instructions on when and how to check the health of a container in a container fleet. When health check properties are set in a container definition, they override any Docker health checks in the container image. For more information on container health checks, see HealthCheck command in the Amazon Elastic Container Service API.

The following example instructions tell the container to wait 100 seconds after launch before counting failed health checks, then initiate the health check command every 60 seconds. After issuing the health check command, wait 10 seconds for it to succeed. If it fails, retry the command 3 times before considering the container to be unhealthy.

{"Command": [ "CMD-SHELL", "ps cax | grep "processmanager" || exit 1" ], "Interval": 300, "Timeout": 30, "Retries": 5, "StartPeriod": 100 }

Part of: ContainerDefinition$HealthCheck

See Also:

  • Method Details

    • hasCommand

      public final boolean hasCommand()
      For responses, this returns true if the service returned a value for the Command property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.

    • command

      public final List<String> command()

      A string array that specifies the command that the container runs to determine if it's healthy.

      Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.

      This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasCommand() method.

      Returns:
      A string array that specifies the command that the container runs to determine if it's healthy.

    • interval

      public final Integer interval()

      The time period (in seconds) between each health check.

      Returns:
      The time period (in seconds) between each health check.

    • timeout

      public final Integer timeout()

      The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

      Returns:
      The time period (in seconds) to wait for a health check to succeed before a failed health check is counted.

    • retries

      public final Integer retries()

      The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

      Returns:
      The number of times to retry a failed health check before the container is considered unhealthy. The first run of the command does not count as a retry.

    • startPeriod

      public final Integer startPeriod()

      The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

      Returns:
      The optional grace period (in seconds) to give a container time to bootstrap before the first failed health check counts toward the number of retries.

    • toBuilder

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

    • builder

      public static ContainerHealthCheck.Builder builder()

    • serializableBuilderClass

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