@aws-cdk/aws-apprunner-alpha.HttpHealthCheckOptions

Experimental

@aws-cdk/aws-apprunner-alpha is an experimental (alpha) package: its API may change in any release, without a major version bump.

HttpHealthCheckOptions Struct

Properties used to define HTTP Based healthchecks.

Stability

Experimental

Source

lib/service.ts

Example

new apprunner.Service(this, 'Service', {
  source: apprunner.Source.fromEcrPublic({
    imageConfiguration: { port: 8000 },
    imageIdentifier: 'public.ecr.aws/aws-containers/hello-app-runner:latest',
  }),
  healthCheck: apprunner.HealthCheck.http({
    healthyThreshold: 5,
    interval: Duration.seconds(10),
    path: '/',
    timeout: Duration.seconds(10),
    unhealthyThreshold: 10,
  }),
});

Properties

healthyThresholdnumberhealthy_thresholdint | floathealthyThresholdNumberHealthyThresholddoubleHealthyThreshold*float64= 1#

The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

intervalDurationintervalDurationintervalDurationIntervalDurationIntervalDuration= Duration.seconds(5)#

The time interval, in seconds, between health checks.

pathstringpathstrpathStringPathstringPath*string= /#

The URL that health check requests are sent to.

timeoutDurationtimeoutDurationtimeoutDurationTimeoutDurationTimeoutDuration= Duration.seconds(2)#

The time, in seconds, to wait for a health check response before deciding it failed.

unhealthyThresholdnumberunhealthy_thresholdint | floatunhealthyThresholdNumberUnhealthyThresholddoubleUnhealthyThreshold*float64= 5#

The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.