Class CfnService.HealthCheckConfigProperty
Public DNS and HTTP namespaces only. A complex type that contains settings for an optional health check. If you specify settings for a health check, AWS Cloud Map associates the health check with the records that you specify in DnsConfig
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.ServiceDiscovery
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class HealthCheckConfigProperty : Object, CfnService.IHealthCheckConfigProperty
Syntax (vb)
Public Class HealthCheckConfigProperty
Inherits Object
Implements CfnService.IHealthCheckConfigProperty
Remarks
If you specify a health check configuration, you can specify either HealthCheckCustomConfig
or HealthCheckConfig
but not both.
Health checks are basic Route 53 health checks that monitor an AWS endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing .
Note the following about configuring health checks.
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.ServiceDiscovery;
var healthCheckConfigProperty = new HealthCheckConfigProperty {
Type = "type",
// the properties below are optional
FailureThreshold = 123,
ResourcePath = "resourcePath"
};
Synopsis
Constructors
HealthCheckConfigProperty() |
Properties
FailureThreshold | The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around. |
ResourcePath | The path that you want Route 53 to request when performing health checks. |
Type | The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy. |
Constructors
HealthCheckConfigProperty()
public HealthCheckConfigProperty()
Properties
FailureThreshold
The number of consecutive health checks that an endpoint must pass or fail for Route 53 to change the current status of the endpoint from unhealthy to healthy or the other way around.
public Nullable<double> FailureThreshold { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .
ResourcePath
The path that you want Route 53 to request when performing health checks.
public string ResourcePath { get; set; }
Property Value
System.String
Remarks
The path can be any value that your endpoint returns an HTTP status code of a 2xx or 3xx format for when the endpoint is healthy. An example file is /docs/route53-health-check.html
. Route 53 automatically adds the DNS name for the service. If you don't specify a value for ResourcePath
, the default value is /
.
If you specify TCP
for Type
, you must not specify a value for ResourcePath
.
Type
The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.
public string Type { get; set; }
Property Value
System.String
Remarks
You can't change the value of Type
after you create a health check.
You can create the following types of health checks:
If you specify HTTPS for the value of <code>Type</code> , the endpoint must support TLS v1.0 or later.
If you specify TCP
for Type
, don't specify a value for ResourcePath
.
For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide .