Class: Aws::AppMesh::Types::VirtualGatewayHealthCheckPolicy
- Inherits:
-
Struct
- Object
- Struct
- Aws::AppMesh::Types::VirtualGatewayHealthCheckPolicy
- Defined in:
- gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb
Overview
When making an API call, you may pass VirtualGatewayHealthCheckPolicy data as a hash:
{
healthy_threshold: 1, # required
interval_millis: 1, # required
path: "String",
port: 1,
protocol: "http", # required, accepts http, http2, grpc
timeout_millis: 1, # required
unhealthy_threshold: 1, # required
}
An object that represents the health check policy for a virtual gateway's listener.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#healthy_threshold ⇒ Integer
The number of consecutive successful health checks that must occur before declaring the 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 gateway unhealthy.
Instance Attribute Details
#healthy_threshold ⇒ Integer
The number of consecutive successful health checks that must occur before declaring the listener healthy.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < 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 gateway unhealthy.
8508 8509 8510 8511 8512 8513 8514 8515 8516 8517 8518 |
# File 'gems/aws-sdk-appmesh/lib/aws-sdk-appmesh/types.rb', line 8508 class VirtualGatewayHealthCheckPolicy < Struct.new( :healthy_threshold, :interval_millis, :path, :port, :protocol, :timeout_millis, :unhealthy_threshold) SENSITIVE = [] include Aws::Structure end |