You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::AppMesh::Types::HealthCheckPolicy

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing HealthCheckPolicy as input to an Aws::Client method, you can use a vanilla Hash:

{
  healthy_threshold: 1, # required
  interval_millis: 1, # required
  path: "String",
  port: 1,
  protocol: "http", # required, accepts http, tcp, http2, grpc
  timeout_millis: 1, # required
  unhealthy_threshold: 1, # required
}

An object that represents the health check policy for a virtual node's listener.

Returned by:

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_thresholdInteger

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

Returns:

  • (Integer)

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

#interval_millisInteger

The time period in milliseconds between each health check execution.

Returns:

  • (Integer)

    The time period in milliseconds between each health check execution.

#pathString

The destination path for the health check request. This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

Returns:

  • (String)

    The destination path for the health check request.

#portInteger

The destination port for the health check request. This port must match the port defined in the PortMapping for the listener.

Returns:

  • (Integer)

    The destination port for the health check request.

#protocolString

The protocol for the health check request. If you specify grpc, then your service must conform to the GRPC Health Checking Protocol.

Returns:

  • (String)

    The protocol for the health check request.

#timeout_millisInteger

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

Returns:

  • (Integer)

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

#unhealthy_thresholdInteger

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

Returns:

  • (Integer)

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