interface HealthCheckConfigurationProperty
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.AppRunner.CfnService.HealthCheckConfigurationProperty |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsapprunner#CfnService_HealthCheckConfigurationProperty |
![]() | software.amazon.awscdk.services.apprunner.CfnService.HealthCheckConfigurationProperty |
![]() | aws_cdk.aws_apprunner.CfnService.HealthCheckConfigurationProperty |
![]() | aws-cdk-lib » aws_apprunner » CfnService » HealthCheckConfigurationProperty |
Obtainable from
Health
.bind()
Describes the settings for the health check that AWS App Runner performs to monitor the health of a service.
Example
// 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,
};
Properties
Name | Type | Description |
---|---|---|
healthy | number | The number of consecutive checks that must succeed before App Runner decides that the service is healthy. |
interval? | number | The time interval, in seconds, between health checks. |
path? | string | The URL that health check requests are sent to. |
protocol? | string | The IP protocol that App Runner uses to perform health checks for your service. |
timeout? | number | The time, in seconds, to wait for a health check response before deciding it failed. |
unhealthy | number | The number of consecutive checks that must fail before App Runner decides that the service is unhealthy. |
healthyThreshold?
Type:
number
(optional)
The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Default: 1
interval?
Type:
number
(optional)
The time interval, in seconds, between health checks.
Default: 5
path?
Type:
string
(optional)
The URL that health check requests are sent to.
Path
is only applicable when you set Protocol
to HTTP
.
Default: "/"
protocol?
Type:
string
(optional)
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
timeout?
Type:
number
(optional)
The time, in seconds, to wait for a health check response before deciding it failed.
Default: 2
unhealthyThreshold?
Type:
number
(optional)
The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
Default: 5