TcpHealthCheckOptions

class aws_cdk.aws_apprunner_alpha.TcpHealthCheckOptions(*, healthy_threshold=None, interval=None, timeout=None, unhealthy_threshold=None)

Bases: object

(experimental) Properties used to define TCP Based healthchecks.

Parameters:

  • healthy_threshold (Union[int, float, None]) – (experimental) The number of consecutive checks that must succeed before App Runner decides that the service is healthy. Default: 1

  • interval (Optional[Duration]) – (experimental) The time interval, in seconds, between health checks. Default: Duration.seconds(5)

  • timeout (Optional[Duration]) – (experimental) The time, in seconds, to wait for a health check response before deciding it failed. Default: Duration.seconds(2)

  • unhealthy_threshold (Union[int, float, None]) – (experimental) The number of consecutive checks that must fail before App Runner decides that the service is unhealthy. Default: 5

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_apprunner_alpha as apprunner_alpha
import aws_cdk as cdk

tcp_health_check_options = apprunner_alpha.TcpHealthCheckOptions(
    healthy_threshold=123,
    interval=cdk.Duration.minutes(30),
    timeout=cdk.Duration.minutes(30),
    unhealthy_threshold=123
)

Attributes

healthy_threshold

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

Default:

1

Stability:

experimental

interval

(experimental) The time interval, in seconds, between health checks.

Default:

Duration.seconds(5)

Stability:

experimental

timeout

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

Default:

Duration.seconds(2)

Stability:

experimental

unhealthy_threshold

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

Default:

5

Stability:

experimental