Skip to content
v2.277.0

HealthCheckConfigurationProperty Struct ​

Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_apprunner as apprunner } from 'aws-cdk-lib';
const healthCheckConfigurationProperty: apprunner.CfnService.HealthCheckConfigurationProperty = {
  healthyThreshold: 123,
  interval: 123,
  path: 'path',
  protocol: 'protocol',
  timeout: 123,
  unhealthyThreshold: 123,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_apprunner as apprunner

health_check_configuration_property = apprunner.CfnService.HealthCheckConfigurationProperty(
    healthy_threshold=123,
    interval=123,
    path="path",
    protocol="protocol",
    timeout=123,
    unhealthy_threshold=123
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.apprunner.*;

HealthCheckConfigurationProperty healthCheckConfigurationProperty = HealthCheckConfigurationProperty.builder()
        .healthyThreshold(123)
        .interval(123)
        .path("path")
        .protocol("protocol")
        .timeout(123)
        .unhealthyThreshold(123)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppRunner;

var healthCheckConfigurationProperty = new HealthCheckConfigurationProperty {
    HealthyThreshold = 123,
    Interval = 123,
    Path = "path",
    Protocol = "protocol",
    Timeout = 123,
    UnhealthyThreshold = 123
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

healthCheckConfigurationProperty := &HealthCheckConfigurationProperty{
	HealthyThreshold: jsii.Number(123),
	Interval: jsii.Number(123),
	Path: jsii.String("path"),
	Protocol: jsii.String("protocol"),
	Timeout: jsii.Number(123),
	UnhealthyThreshold: jsii.Number(123),
}

Properties ​

healthyThresholdoptionalnumberhealthy_thresholdoptionalint | floathealthyThresholdoptionalNumberHealthyThresholdoptionaldoubleHealthyThresholdoptional*float64 #
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.

Default: 1

intervaloptionalnumberintervaloptionalint | floatintervaloptionalNumberIntervaloptionaldoubleIntervaloptional*float64 #
The time interval, in seconds, between health checks.

Default: 5

pathoptionalstringpathoptionalstrpathoptionalStringPathoptionalstringPathoptional*string #
The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP .

Default: "/"

protocoloptionalstringprotocoloptionalstrprotocoloptionalStringProtocoloptionalstringProtocoloptional*string #
The IP protocol that App Runner uses to perform health checks for your service.

If you set Protocol to HTTP , App Runner sends health check requests to the HTTP path specified by Path .

Default: TCP

timeoutoptionalnumbertimeoutoptionalint | floattimeoutoptionalNumberTimeoutoptionaldoubleTimeoutoptional*float64 #
The time, in seconds, to wait for a health check response before deciding it failed.

Default: 2

unhealthyThresholdoptionalnumberunhealthy_thresholdoptionalint | floatunhealthyThresholdoptionalNumberUnhealthyThresholdoptionaldoubleUnhealthyThresholdoptional*float64 #
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Default: 5