Show / Hide Table of Contents

Class CfnVirtualNode.HealthCheckProperty

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

Inheritance
object
CfnVirtualNode.HealthCheckProperty
Implements
CfnVirtualNode.IHealthCheckProperty
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.AWS.AppMesh
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVirtualNode.HealthCheckProperty : CfnVirtualNode.IHealthCheckProperty
Syntax (vb)
Public Class CfnVirtualNode.HealthCheckProperty Implements CfnVirtualNode.IHealthCheckProperty
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             var healthCheckProperty = new HealthCheckProperty {
                 HealthyThreshold = 123,
                 IntervalMillis = 123,
                 Protocol = "protocol",
                 TimeoutMillis = 123,
                 UnhealthyThreshold = 123,

                 // the properties below are optional
                 Path = "path",
                 Port = 123
             };

Synopsis

Constructors

HealthCheckProperty()

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

Properties

HealthyThreshold

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

IntervalMillis

The time period in milliseconds between each health check execution.

Path

The destination path for the health check request.

Port

The destination port for the health check request.

Protocol

The protocol for the health check request.

TimeoutMillis

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

UnhealthyThreshold

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

Constructors

HealthCheckProperty()

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

public HealthCheckProperty()
Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.AppMesh;

             var healthCheckProperty = new HealthCheckProperty {
                 HealthyThreshold = 123,
                 IntervalMillis = 123,
                 Protocol = "protocol",
                 TimeoutMillis = 123,
                 UnhealthyThreshold = 123,

                 // the properties below are optional
                 Path = "path",
                 Port = 123
             };

Properties

HealthyThreshold

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

public double HealthyThreshold { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-healthythreshold

IntervalMillis

The time period in milliseconds between each health check execution.

public double IntervalMillis { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-intervalmillis

Path

The destination path for the health check request.

public string? Path { get; set; }
Property Value

string

Remarks

This value is only used if the specified protocol is HTTP or HTTP/2. For any other protocol, this value is ignored.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-path

Port

The destination port for the health check request.

public double? Port { get; set; }
Property Value

double?

Remarks

This port must match the port defined in the PortMapping for the listener.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-port

Protocol

The protocol for the health check request.

public string Protocol { get; set; }
Property Value

string

Remarks

If you specify grpc , then your service must conform to the GRPC Health Checking Protocol .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-protocol

TimeoutMillis

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

public double TimeoutMillis { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-timeoutmillis

UnhealthyThreshold

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

public double UnhealthyThreshold { get; set; }
Property Value

double

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-appmesh-virtualnode-healthcheck.html#cfn-appmesh-virtualnode-healthcheck-unhealthythreshold

Implements

CfnVirtualNode.IHealthCheckProperty
Back to top Generated by DocFX