Class HealthCheck

(experimental) Contains static factory methods for creating health checks for different protocols.

Inheritance

object

HealthCheck

Namespace: Amazon.CDK.AWS.AppRunner.Alpha

Assembly: Amazon.CDK.AWS.AppRunner.Alpha.dll

Syntax (csharp)

public class HealthCheck : DeputyBase

Syntax (vb)

Public Class HealthCheck Inherits DeputyBase

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

Properties

HealthCheckProtocolType	(experimental) Contains static factory methods for creating health checks for different protocols.
HealthyThreshold	(experimental) Contains static factory methods for creating health checks for different protocols.
Interval	(experimental) Contains static factory methods for creating health checks for different protocols.
Path	(experimental) Contains static factory methods for creating health checks for different protocols.
Timeout	(experimental) Contains static factory methods for creating health checks for different protocols.
UnhealthyThreshold	(experimental) Contains static factory methods for creating health checks for different protocols.

Methods

Bind()	(experimental) Contains static factory methods for creating health checks for different protocols.
Http(IHttpHealthCheckOptions?)	(experimental) Construct a HTTP health check.
Tcp(ITcpHealthCheckOptions?)	(experimental) Construct a TCP health check.

Properties

HealthCheckProtocolType

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual HealthCheckProtocolType HealthCheckProtocolType { get; }

Property Value

HealthCheckProtocolType

Remarks

Stability: Experimental

HealthyThreshold

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual double HealthyThreshold { get; }

Property Value

double

Remarks

Stability: Experimental

Interval

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual Duration Interval { get; }

Property Value

Duration

Remarks

Stability: Experimental

Path

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual string? Path { get; }

Property Value

string

Remarks

Stability: Experimental

Timeout

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual Duration Timeout { get; }

Property Value

Duration

Remarks

Stability: Experimental

UnhealthyThreshold

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual double UnhealthyThreshold { get; }

Property Value

double

Remarks

Stability: Experimental

Methods

Bind()

(experimental) Contains static factory methods for creating health checks for different protocols.

public virtual CfnService.IHealthCheckConfigurationProperty Bind()

Returns

CfnService.IHealthCheckConfigurationProperty

Remarks

Stability: Experimental

Http(IHttpHealthCheckOptions?)

(experimental) Construct a HTTP health check.

public static HealthCheck Http(IHttpHealthCheckOptions? options = null)

Parameters

options IHttpHealthCheckOptions

Returns

HealthCheck

Remarks

Stability: Experimental

Tcp(ITcpHealthCheckOptions?)

(experimental) Construct a TCP health check.

public static HealthCheck Tcp(ITcpHealthCheckOptions? options = null)

Parameters

options ITcpHealthCheckOptions

Returns

HealthCheck

Remarks

Stability: Experimental