Class CfnTargetGroup.HealthCheckConfigProperty
Describes the health check configuration of a target group.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.VpcLattice
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HealthCheckConfigProperty : Object, CfnTargetGroup.IHealthCheckConfigProperty
Syntax (vb)
Public Class HealthCheckConfigProperty
Inherits Object
Implements CfnTargetGroup.IHealthCheckConfigProperty
Remarks
Health check configurations aren't used for target groups of type LAMBDA
or ALB
.
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.VpcLattice;
var healthCheckConfigProperty = new HealthCheckConfigProperty {
Enabled = false,
HealthCheckIntervalSeconds = 123,
HealthCheckTimeoutSeconds = 123,
HealthyThresholdCount = 123,
Matcher = new MatcherProperty {
HttpCode = "httpCode"
},
Path = "path",
Port = 123,
Protocol = "protocol",
ProtocolVersion = "protocolVersion",
UnhealthyThresholdCount = 123
};
Synopsis
Constructors
HealthCheckConfigProperty() |
Properties
Enabled | Indicates whether health checking is enabled. |
HealthCheckIntervalSeconds | The approximate amount of time, in seconds, between health checks of an individual target. |
HealthCheckTimeoutSeconds | The amount of time, in seconds, to wait before reporting a target as unhealthy. |
HealthyThresholdCount | The number of consecutive successful health checks required before considering an unhealthy target healthy. |
Matcher | The codes to use when checking for a successful response from a target. |
Path | The destination for health checks on the targets. |
Port | The port used when performing health checks on targets. |
Protocol | The protocol used when performing health checks on targets. |
ProtocolVersion | The protocol version used when performing health checks on targets. |
UnhealthyThresholdCount | The number of consecutive failed health checks required before considering a target unhealthy. |
Constructors
HealthCheckConfigProperty()
public HealthCheckConfigProperty()
Properties
Enabled
Indicates whether health checking is enabled.
public object Enabled { get; set; }
Property Value
System.Object
Remarks
HealthCheckIntervalSeconds
The approximate amount of time, in seconds, between health checks of an individual target.
public Nullable<double> HealthCheckIntervalSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The range is 5–300 seconds. The default is 30 seconds.
HealthCheckTimeoutSeconds
The amount of time, in seconds, to wait before reporting a target as unhealthy.
public Nullable<double> HealthCheckTimeoutSeconds { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The range is 1–120 seconds. The default is 5 seconds.
HealthyThresholdCount
The number of consecutive successful health checks required before considering an unhealthy target healthy.
public Nullable<double> HealthyThresholdCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Matcher
The codes to use when checking for a successful response from a target.
public object Matcher { get; set; }
Property Value
System.Object
Remarks
Path
The destination for health checks on the targets.
public string Path { get; set; }
Property Value
System.String
Remarks
If the protocol version is HTTP/1.1
or HTTP/2
, specify a valid URI (for example, /path?query
). The default path is /
. Health checks are not supported if the protocol version is gRPC
, however, you can choose HTTP/1.1
or HTTP/2
and specify a valid URI.
Port
The port used when performing health checks on targets.
public Nullable<double> Port { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The default setting is the port that a target receives traffic on.
Protocol
The protocol used when performing health checks on targets.
public string Protocol { get; set; }
Property Value
System.String
Remarks
The possible protocols are HTTP
and HTTPS
. The default is HTTP
.
ProtocolVersion
The protocol version used when performing health checks on targets.
public string ProtocolVersion { get; set; }
Property Value
System.String
Remarks
The possible protocol versions are HTTP1
and HTTP2
.
UnhealthyThresholdCount
The number of consecutive failed health checks required before considering a target unhealthy.
public Nullable<double> UnhealthyThresholdCount { get; set; }
Property Value
System.Nullable<System.Double>