TaskDefinitionHealthCheck class
The health check command and associated configuration parameters for the container.
Constructors
-
TaskDefinitionHealthCheck({Input<
List< ? command, Input<String> ?>int?> ? interval, Input<int?> ? retries, Input<int?> ? startPeriod, Input<int?> ? timeout}) -
Creates a new TaskDefinitionHealthCheck.
commandA string array representing the command that the container runs to determine if it is healthy.intervalThe time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.retriesThe 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 three retries.startPeriodThe 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.timeoutThe 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 seconds.const -
TaskDefinitionHealthCheck.fromMap(Map<
String, dynamic> map) -
factory
Properties
-
command
→ Input<
List< ?String> ?> -
A string array representing the command that the container runs to determine if it is healthy.
final
- hashCode → int
-
The hash code for this object.
no setterinherited
-
interval
→ Input<
int?> ? -
The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.
final
-
retries
→ Input<
int?> ? -
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 three retries.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
startPeriod
→ Input<
int?> ? -
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.
final
-
timeout
→ Input<
int?> ? -
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 seconds.
final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toMap(
) → Map< String, dynamic> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited