Show / Hide Table of Contents

Interface CfnService.IHealthCheckConfigurationProperty

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

Namespace: Amazon.CDK.AWS.AppRunner

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public interface CfnService.IHealthCheckConfigurationProperty

Syntax (vb)

Public Interface CfnService.IHealthCheckConfigurationProperty

Remarks

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

ExampleMetadata: fixture=_generated

Examples

// 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
             };

Synopsis

Properties

HealthyThreshold	The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
Interval	The time interval, in seconds, between health checks.
Path	The URL that health check requests are sent to.
Protocol	The IP protocol that App Runner uses to perform health checks for your service.
Timeout	The time, in seconds, to wait for a health check response before deciding it failed.
UnhealthyThreshold	The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.

Properties

HealthyThreshold

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

double? HealthyThreshold { get; }

Property Value

Remarks

Default: 1

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

Interval

The time interval, in seconds, between health checks.

double? Interval { get; }

Property Value

Remarks

Default: 5

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

Path

The URL that health check requests are sent to.

string? Path { get; }

Property Value

Remarks

Path is only applicable when you set Protocol to HTTP .

Default: "/"

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

Protocol

The IP protocol that App Runner uses to perform health checks for your service.

string? Protocol { get; }

Property Value

Remarks

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

Default: TCP

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

Timeout

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

double? Timeout { get; }

Property Value

Remarks

Default: 2

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

UnhealthyThreshold

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

double? UnhealthyThreshold { get; }

Property Value

Remarks

Default: 5

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