AWS::AppMesh::VirtualGateway VirtualGatewayHealthCheckPolicy - Amazon CloudFormation
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

AWS::AppMesh::VirtualGateway VirtualGatewayHealthCheckPolicy

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

Syntax

To declare this entity in your Amazon CloudFormation template, use the following syntax:

JSON

{ "HealthyThreshold" : Integer, "IntervalMillis" : Integer, "Path" : String, "Port" : Integer, "Protocol" : String, "TimeoutMillis" : Integer, "UnhealthyThreshold" : Integer }

YAML

HealthyThreshold: Integer IntervalMillis: Integer Path: String Port: Integer Protocol: String TimeoutMillis: Integer UnhealthyThreshold: Integer

Properties

HealthyThreshold

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

Required: Yes

Type: Integer

Minimum: 2

Maximum: 10

Update requires: No interruption

IntervalMillis

The time period in milliseconds between each health check execution.

Required: Yes

Type: Integer

Update requires: No interruption

Path

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.

Required: No

Type: String

Update requires: No interruption

Port

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

Required: No

Type: Integer

Minimum: 1

Maximum: 65535

Update requires: No interruption

Protocol

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

Required: Yes

Type: String

Allowed values: grpc | http | http2

Update requires: No interruption

TimeoutMillis

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

Required: Yes

Type: Integer

Update requires: No interruption

UnhealthyThreshold

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

Required: Yes

Type: Integer

Minimum: 2

Maximum: 10

Update requires: No interruption