Class HealthCheckConfiguration

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

Describes the settings for the health check that App Runner performs to monitor the health of a service.

See Also:

  • Method Details

    • protocol

      public final HealthCheckProtocol protocol()

      The IP protocol that App Runner uses to perform health checks for your service.

      If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

      Default: TCP

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

      Returns:
      The IP protocol that App Runner uses to perform health checks for your service.

      If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

      Default: TCP

      See Also:

    • protocolAsString

      public final String protocolAsString()

      The IP protocol that App Runner uses to perform health checks for your service.

      If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

      Default: TCP

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

      Returns:
      The IP protocol that App Runner uses to perform health checks for your service.

      If you set Protocol to HTTP, App Runner sends health check requests to the HTTP path specified by Path.

      Default: TCP

      See Also:

    • path

      public final String path()

      The URL that health check requests are sent to.

      Path is only applicable when you set Protocol to HTTP.

      Default: "/"

      Returns:
      The URL that health check requests are sent to.

      Path is only applicable when you set Protocol to HTTP.

      Default: "/"

    • interval

      public final Integer interval()

      The time interval, in seconds, between health checks.

      Default: 5

      Returns:
      The time interval, in seconds, between health checks.

      Default: 5

    • timeout

      public final Integer timeout()

      The time, in seconds, to wait for a health check response before deciding it failed.

      Default: 2

      Returns:
      The time, in seconds, to wait for a health check response before deciding it failed.

      Default: 2

    • healthyThreshold

      public final Integer healthyThreshold()

      The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

      Default: 1

      Returns:
      The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

      Default: 1

    • unhealthyThreshold

      public final Integer unhealthyThreshold()

      The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

      Default: 5

      Returns:
      The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

      Default: 5

    • toBuilder

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

    • builder

      public static HealthCheckConfiguration.Builder builder()

    • serializableBuilderClass

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

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.