API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see

We welcome your feedback on this new version of the documentation. Send your comments to


import ""

type HealthCheck struct { Command []*string `locationName:"command" type:"list" required:"true"` Interval *int64 `locationName:"interval" type:"integer"` Retries *int64 `locationName:"retries" type:"integer"` StartPeriod *int64 `locationName:"startPeriod" type:"integer"` Timeout *int64 `locationName:"timeout" type:"integer"` }

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 are not supported for tasks that are part of a service that is configured to use a Classic Load Balancer.


Type: []*string

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 (

Command is a required field


Type: *int64

The time period in seconds between each health check execution. You may specify between 5 and 300 seconds. The default value is 30 seconds.


Type: *int64

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.


Type: *int64

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.


Type: *int64

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.



func (s HealthCheck) GoString() string

GoString returns the string representation


func (s *HealthCheck) SetCommand(v []*string) *HealthCheck

SetCommand sets the Command field's value.


func (s *HealthCheck) SetInterval(v int64) *HealthCheck

SetInterval sets the Interval field's value.


func (s *HealthCheck) SetRetries(v int64) *HealthCheck

SetRetries sets the Retries field's value.


func (s *HealthCheck) SetStartPeriod(v int64) *HealthCheck

SetStartPeriod sets the StartPeriod field's value.


func (s *HealthCheck) SetTimeout(v int64) *HealthCheck

SetTimeout sets the Timeout field's value.


func (s HealthCheck) String() string

String returns the string representation


func (s *HealthCheck) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: