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

Inherits:

Struct

• Object
• Struct
• Aws::AppMesh::Types::HealthCheckPolicy

Includes:

Structure

Defined in:

lib/aws-sdk-appmesh/types.rb

Overview

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

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #healthy_threshold ⇒ Integer

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

• #interval_millis ⇒ Integer

  The time period in milliseconds between each health check execution.

• #path ⇒ String

  The destination path for the health check request.

• #port ⇒ Integer

  The destination port for the health check request.

• #protocol ⇒ String

  The protocol for the health check request.

• #timeout_millis ⇒ Integer

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

• #unhealthy_threshold ⇒ Integer

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

Instance Attribute Details

#healthy_threshold ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#interval_millis ⇒ Integer

The time period in milliseconds between each health check execution.

Returns:

• (Integer)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#path ⇒ String

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)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#port ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#protocol ⇒ String

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

[1]: github.com/grpc/grpc/blob/master/doc/health-checking.md

Returns:

• (String)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_millis ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end

#unhealthy_threshold ⇒ Integer

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

Returns:

• (Integer)

# File 'lib/aws-sdk-appmesh/types.rb', line 2230

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  SENSITIVE = []
  include Aws::Structure
end