Package software.amazon.awssdk.services.apprunner.model

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:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	HealthCheckConfiguration.Builder

Method Summary

Modifier and Type	Method	Description
static HealthCheckConfiguration.Builder	builder()
boolean	equals(Object obj)
boolean	equalsBySdkFields(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
Integer	healthyThreshold()	The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Integer	interval()	The time interval, in seconds, between health checks.
String	path()	The URL that health check requests are sent to.
HealthCheckProtocol	protocol()	The IP protocol that App Runner uses to perform health checks for your service.
String	protocolAsString()	The IP protocol that App Runner uses to perform health checks for your service.
Map<String,SdkField<?>>	sdkFieldNameToField()
List<SdkField<?>>	sdkFields()
static Class<? extends HealthCheckConfiguration.Builder>	serializableBuilderClass()
Integer	timeout()	The time, in seconds, to wait for a health check response before deciding it failed.
HealthCheckConfiguration.Builder	toBuilder()
String	toString()	Returns a string representation of this object.
Integer	unhealthyThreshold()	The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

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

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:

HealthCheckProtocol

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:

HealthCheckProtocol

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()

Specified by:

toBuilder in interface ToCopyableBuilder<HealthCheckConfiguration.Builder,HealthCheckConfiguration>

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)

Specified by:

equalsBySdkFields in interface SdkPojo

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

sdkFieldNameToField

public final Map<String,SdkField<?>> sdkFieldNameToField()

Specified by:

sdkFieldNameToField in interface SdkPojo