@Generated(value="software.amazon.awssdk:codegen") public final class HealthCheck extends Object implements SdkPojo, Serializable, ToCopyableBuilder<HealthCheck.Builder,HealthCheck>
An object representing a container health check. Health check parameters that are specified in a container definition override any Docker health checks that exist in the container image (such as those specified in a parent image or from the image's Dockerfile).
The following are notes about container health check support:
Container health checks require version 1.17.0 or greater of the Amazon ECS container agent. For more information, see Updating the Amazon ECS Container Agent.
Container health checks are supported for Fargate tasks if you are using platform version 1.1.0 or greater. For more information, see AWS Fargate Platform Versions.
Container health checks are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.
| Modifier and Type | Class and Description |
|---|---|
static interface |
HealthCheck.Builder |
| Modifier and Type | Method and Description |
|---|---|
static HealthCheck.Builder |
builder() |
List<String> |
command()
A string array representing the command that the container runs to determine if it is healthy.
|
boolean |
equals(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
int |
hashCode() |
Integer |
interval()
The time period in seconds between each health check execution.
|
Integer |
retries()
The number of times to retry a failed health check before the container is considered unhealthy.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends HealthCheck.Builder> |
serializableBuilderClass() |
Integer |
startPeriod()
The optional grace period within which to provide containers time to bootstrap before failed health checks count
towards the maximum number of retries.
|
Integer |
timeout()
The time period in seconds to wait for a health check to succeed before it is considered a failure.
|
HealthCheck.Builder |
toBuilder()
Take this object and create a builder that contains all of the current property values of this object.
|
String |
toString() |
copypublic List<String> command()
A string array representing the command that the container runs to determine if it is healthy. The string array
must start with CMD to execute the command arguments directly, or CMD-SHELL to run the
command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck in the Create a container section of the
Docker Remote API.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
CMD to execute the command arguments directly, or
CMD-SHELL to run the command with the container's default shell. For example:
[ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ]
An exit code of 0 indicates success, and non-zero exit code indicates failure. For more information, see
HealthCheck in the Create a container section
of the Docker Remote API.
public Integer interval()
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
public Integer timeout()
The time period in seconds to wait for a health check to succeed before it is considered a failure. You may specify between 2 and 60 seconds. The default value is 5.
public Integer retries()
The number of times to retry a failed health check before the container is considered unhealthy. You may specify between 1 and 10 retries. The default value is 3.
public Integer startPeriod()
The optional grace period within which to provide containers time to bootstrap before failed health checks count
towards the maximum number of retries. You may specify between 0 and 300 seconds. The startPeriod is
disabled by default.
If a health check succeeds within the startPeriod, then the container is considered healthy and any
subsequent failures count toward the maximum number of retries.
startPeriod is disabled by default.
If a health check succeeds within the startPeriod, then the container is considered healthy
and any subsequent failures count toward the maximum number of retries.
public HealthCheck.Builder toBuilder()
ToCopyableBuildertoBuilder in interface ToCopyableBuilder<HealthCheck.Builder,HealthCheck>public static HealthCheck.Builder builder()
public static Class<? extends HealthCheck.Builder> serializableBuilderClass()
Copyright © 2017 Amazon Web Services, Inc. All Rights Reserved.