aws-cdk-lib.aws_ecs.HealthCheck

HealthCheck Struct

The health check command and associated configuration parameters for the container.

Source

aws-ecs/lib/container-definition.ts

Example

declare const vpc: ec2.Vpc;
declare const securityGroup: ec2.SecurityGroup;
const queueProcessingFargateService = new ecsPatterns.QueueProcessingFargateService(this, 'Service', {
  vpc,
  memoryLimitMiB: 512,
  image: ecs.ContainerImage.fromRegistry('test'),
  minHealthyPercent: 100,
  healthCheck: {
    command: [ "CMD-SHELL", "curl -f http://localhost/ || exit 1" ],
    // the properties below are optional
    interval: Duration.minutes(30),
    retries: 123,
    startPeriod: Duration.minutes(30),
    timeout: Duration.minutes(30),
  },
});

Properties

commandstring[]commandtyping.List[str]commandList<String>Commandstring[]Command*[]*stringrequired#

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" ]

interval?optionalDurationinterval?optionalDurationinterval?optionalDurationInterval?optionalDurationInterval?optionalDuration= Duration.seconds(30)#

The time period in seconds between each health check execution.

You may specify between 5 and 300 seconds.

retries?optionalnumberretries?optionalint | floatretries?optionalNumberRetries?optionaldoubleRetries?optional*float64= 3#

The number of times to retry a failed health check before the container is considered unhealthy.

You may specify between 1 and 10 retries.

startPeriod?optionalDurationstart_period?optionalDurationstartPeriod?optionalDurationStartPeriod?optionalDurationStartPeriod?optionalDuration#

The optional grace period within which to provide containers time to bootstrap before failed health checks count towards the maximum number of retries.

Default: No start period

You may specify between 0 and 300 seconds.

timeout?optionalDurationtimeout?optionalDurationtimeout?optionalDurationTimeout?optionalDurationTimeout?optionalDuration= Duration.seconds(5)#

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.