Class HttpHealthCheckOptions
(experimental) Properties used to define HTTP Based healthchecks.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.AppRunner.Alpha
Assembly: Amazon.CDK.AWS.AppRunner.Alpha.dll
Syntax (csharp)
public class HttpHealthCheckOptions : Object, IHttpHealthCheckOptions
Syntax (vb)
Public Class HttpHealthCheckOptions
Inherits Object
Implements IHttpHealthCheckOptions
Remarks
Stability: Experimental
ExampleMetadata: infused
Examples
new Service(this, "Service", new ServiceProps {
Source = Source.FromEcrPublic(new EcrPublicProps {
ImageConfiguration = new ImageConfiguration { Port = 8000 },
ImageIdentifier = "public.ecr.aws/aws-containers/hello-app-runner:latest"
}),
HealthCheck = HealthCheck.Http(new HttpHealthCheckOptions {
HealthyThreshold = 5,
Interval = Duration.Seconds(10),
Path = "/",
Timeout = Duration.Seconds(10),
UnhealthyThreshold = 10
})
});
Synopsis
Constructors
HttpHealthCheckOptions() |
Properties
HealthyThreshold | (experimental) The number of consecutive checks that must succeed before App Runner decides that the service is healthy. |
Interval | (experimental) The time interval, in seconds, between health checks. |
Path | (experimental) The URL that health check requests are sent to. |
Timeout | (experimental) The time, in seconds, to wait for a health check response before deciding it failed. |
UnhealthyThreshold | (experimental) The number of consecutive checks that must fail before App Runner decides that the service is unhealthy. |
Constructors
HttpHealthCheckOptions()
public HttpHealthCheckOptions()
Properties
HealthyThreshold
(experimental) The number of consecutive checks that must succeed before App Runner decides that the service is healthy.
public Nullable<double> HealthyThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 1
Stability: Experimental
Interval
(experimental) The time interval, in seconds, between health checks.
public Duration Interval { get; set; }
Property Value
Remarks
Default: Duration.seconds(5)
Stability: Experimental
Path
(experimental) The URL that health check requests are sent to.
public string Path { get; set; }
Property Value
System.String
Remarks
Default: /
Stability: Experimental
Timeout
(experimental) The time, in seconds, to wait for a health check response before deciding it failed.
public Duration Timeout { get; set; }
Property Value
Remarks
Default: Duration.seconds(2)
Stability: Experimental
UnhealthyThreshold
(experimental) The number of consecutive checks that must fail before App Runner decides that the service is unhealthy.
public Nullable<double> UnhealthyThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 5
Stability: Experimental