interface HealthCheckConfigurationProperty

Language	Type name
.NET	Amazon.CDK.Mixins.Preview.AWS.AppRunner.Mixins.CfnServicePropsMixin.HealthCheckConfigurationProperty
Go	github.com/aws/aws-cdk-go/awscdkmixinspreview/v2/awsapprunner/mixins#CfnServicePropsMixin_HealthCheckConfigurationProperty
Java	software.amazon.awscdk.mixins.preview.services.apprunner.mixins.CfnServicePropsMixin.HealthCheckConfigurationProperty
Python	aws_cdk.mixins_preview.aws_apprunner.mixins.CfnServicePropsMixin.HealthCheckConfigurationProperty
TypeScript	@aws-cdk/mixins-preview » aws_apprunner » mixins » CfnServicePropsMixin » HealthCheckConfigurationProperty

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { mixins as apprunner_mixins } from '@aws-cdk/mixins-preview/aws-apprunner';
const healthCheckConfigurationProperty: apprunner_mixins.CfnServicePropsMixin.HealthCheckConfigurationProperty = {
  healthyThreshold: 123,
  interval: 123,
  path: 'path',
  protocol: 'protocol',
  timeout: 123,
  unhealthyThreshold: 123,
};

Properties

Name	Type	Description
healthyThreshold?	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.
unhealthyThreshold?	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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-healthythreshold

---

interval?

Type: number (optional)

The time interval, in seconds, between health checks.

Default: 5

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-interval

---

path?

Type: string (optional)

The URL that health check requests are sent to.

Path is only applicable when you set Protocol to HTTP .

Default: "/"

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-path

---

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

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-protocol

---

timeout?

Type: number (optional)

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

Default: 2

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-timeout

---

unhealthyThreshold?

Type: number (optional)

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

Default: 5

See also: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-apprunner-service-healthcheckconfiguration.html#cfn-apprunner-service-healthcheckconfiguration-unhealthythreshold