HealthCheck

class aws_cdk.aws_appmesh.HealthCheck(*, healthy_threshold=None, interval=None, path=None, port=None, protocol=None, timeout=None, unhealthy_threshold=None)

Bases: object

(experimental) Properties used to define healthchecks when creating virtual nodes.

All values have a default if only specified as {} when creating. If property not set, then no healthchecks will be defined.

Parameters
  • healthy_threshold (Union[int, float, None]) – (experimental) Number of successful attempts before considering the node UP. Default: 2

  • interval (Optional[Duration]) – (experimental) Interval in milliseconds to re-check. Default: 5 seconds

  • path (Optional[str]) – (experimental) The path where the application expects any health-checks, this can also be the application path. Default: /

  • port (Union[int, float, None]) – (experimental) The TCP port number for the healthcheck. Default: - same as corresponding port mapping

  • protocol (Optional[Protocol]) – (experimental) The protocol to use for the healthcheck, for convinience a const enum has been defined. Protocol.HTTP or Protocol.TCP Default: - same as corresponding port mapping

  • timeout (Optional[Duration]) – (experimental) Timeout in milli-seconds for the healthcheck to be considered a fail. Default: 2 seconds

  • unhealthy_threshold (Union[int, float, None]) – (experimental) Number of failed attempts before considering the node DOWN. Default: 2

Stability

experimental

Attributes

healthy_threshold

(experimental) Number of successful attempts before considering the node UP.

Default

2

Stability

experimental

Return type

Union[int, float, None]

interval

(experimental) Interval in milliseconds to re-check.

Default

5 seconds

Stability

experimental

Return type

Optional[Duration]

path

(experimental) The path where the application expects any health-checks, this can also be the application path.

Default

/

Stability

experimental

Return type

Optional[str]

port

(experimental) The TCP port number for the healthcheck.

Default
  • same as corresponding port mapping

Stability

experimental

Return type

Union[int, float, None]

protocol

(experimental) The protocol to use for the healthcheck, for convinience a const enum has been defined.

Protocol.HTTP or Protocol.TCP

Default
  • same as corresponding port mapping

Stability

experimental

Return type

Optional[Protocol]

timeout

(experimental) Timeout in milli-seconds for the healthcheck to be considered a fail.

Default

2 seconds

Stability

experimental

Return type

Optional[Duration]

unhealthy_threshold

(experimental) Number of failed attempts before considering the node DOWN.

Default

2

Stability

experimental

Return type

Union[int, float, None]