Class: Aws::AppMesh::Types::HealthCheckPolicy
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppMesh::Types::HealthCheckPolicy
- Includes:
- Structure
- Defined in:
- lib/aws-sdk-appmesh/types.rb
Overview
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: "grpc", # required, accepts grpc, http, http2, tcp
timeout_millis: 1, # required
unhealthy_threshold: 1, # required
}
An object that represents the health check policy for a virtual node’s listener.
Instance Attribute Summary collapse
-
#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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 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.
812 813 814 815 816 817 818 819 820 821 |
# File 'lib/aws-sdk-appmesh/types.rb', line 812 class HealthCheckPolicy < Struct.new( :healthy_threshold, :interval_millis, :path, :port, :protocol, :timeout_millis, :unhealthy_threshold) include Aws::Structure end |