GrpcHealthCheckOptions

class aws_cdk.aws_appmesh.GrpcHealthCheckOptions(*, healthy_threshold=None, interval=None, timeout=None, unhealthy_threshold=None)

Bases: object

Properties used to define GRPC Based healthchecks.

Parameters
  • healthy_threshold (Union[int, float, None]) – The number of consecutive successful health checks that must occur before declaring listener healthy. Default: 2

  • interval (Optional[Duration]) – The time period between each health check execution. Default: Duration.seconds(5)

  • timeout (Optional[Duration]) – The amount of time to wait when receiving a response from the health check. Default: Duration.seconds(2)

  • unhealthy_threshold (Union[int, float, None]) – The number of consecutive failed health checks that must occur before declaring a listener unhealthy. Default: - 2

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_appmesh as appmesh
import aws_cdk.core as cdk

grpc_health_check_options = appmesh.GrpcHealthCheckOptions(
    healthy_threshold=123,
    interval=cdk.Duration.minutes(30),
    timeout=cdk.Duration.minutes(30),
    unhealthy_threshold=123
)

Attributes

healthy_threshold

The number of consecutive successful health checks that must occur before declaring listener healthy.

Default

2

Return type

Union[int, float, None]

interval

The time period between each health check execution.

Default

Duration.seconds(5)

Return type

Optional[Duration]

timeout

The amount of time to wait when receiving a response from the health check.

Default

Duration.seconds(2)

Return type

Optional[Duration]

unhealthy_threshold

The number of consecutive failed health checks that must occur before declaring a listener unhealthy.

Default
  • 2

Return type

Union[int, float, None]