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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-appmesh/types.rb

Overview

Note:

When making an API call, you may pass HealthCheckPolicy data as a hash:

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

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

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#healthy_threshold ⇒ Integer

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

Returns:

  • (Integer) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

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

#interval_millis ⇒ Integer

The time period in milliseconds between each health check execution.

Returns:

  • (Integer) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

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

#path ⇒ String

The destination path for the health check request. This is required only if the specified protocol is HTTP. If the protocol is TCP, this parameter is ignored.

Returns:

  • (String) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  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) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

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

#protocol ⇒ String

The protocol for the health check request.

Returns:

  • (String) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  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) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

class HealthCheckPolicy < Struct.new(
  :healthy_threshold,
  :interval_millis,
  :path,
  :port,
  :protocol,
  :timeout_millis,
  :unhealthy_threshold)
  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) 


756
757
758
759
760
761
762
763
764
765
 
# File 'lib/aws-sdk-appmesh/types.rb', line 756

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