AWS SDK for C++  1.9.132
AWS SDK for C++
Public Member Functions | List of all members
Aws::ServiceDiscovery::Model::HealthCheckConfig Class Reference

#include <HealthCheckConfig.h>

Public Member Functions

 HealthCheckConfig ()
 
 HealthCheckConfig (Aws::Utils::Json::JsonView jsonValue)
 
HealthCheckConfigoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const HealthCheckTypeGetType () const
 
bool TypeHasBeenSet () const
 
void SetType (const HealthCheckType &value)
 
void SetType (HealthCheckType &&value)
 
HealthCheckConfigWithType (const HealthCheckType &value)
 
HealthCheckConfigWithType (HealthCheckType &&value)
 
const Aws::StringGetResourcePath () const
 
bool ResourcePathHasBeenSet () const
 
void SetResourcePath (const Aws::String &value)
 
void SetResourcePath (Aws::String &&value)
 
void SetResourcePath (const char *value)
 
HealthCheckConfigWithResourcePath (const Aws::String &value)
 
HealthCheckConfigWithResourcePath (Aws::String &&value)
 
HealthCheckConfigWithResourcePath (const char *value)
 
int GetFailureThreshold () const
 
bool FailureThresholdHasBeenSet () const
 
void SetFailureThreshold (int value)
 
HealthCheckConfigWithFailureThreshold (int value)
 

Detailed Description

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, Cloud Map associates the health check with the records that you specify in DnsConfig.

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 Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

Note the following about configuring health checks.

A and AAAA records

If DnsConfig includes configurations for both A and AAAA records, Cloud Map creates a health check that uses the IPv4 address to check the health of the resource. If the endpoint tthat's specified by the IPv4 address is unhealthy, Route 53 considers both the A and AAAA records to be unhealthy.

CNAME records

You can't specify settings for HealthCheckConfig when the DNSConfig includes CNAME for the value of Type. If you do, the CreateService request will fail with an InvalidInput error.

Request interval

A Route 53 health checker in each health-checking Amazon Web Services Region sends a health check request to an endpoint every 30 seconds. On average, your endpoint receives a health check request about every two seconds. However, health checkers don't coordinate with one another. Therefore, you might sometimes see several requests in one second that's followed by a few seconds with no health checks at all.

Health checking regions

Health checkers perform checks from all Route 53 health-checking Regions. For a list of the current Regions, see Regions.

Alias records

When you register an instance, if you include the AWS_ALIAS_DNS_NAME attribute, Cloud Map creates a Route 53 alias record. Note the following:

  • Route 53 automatically sets EvaluateTargetHealth to true for alias records. When EvaluateTargetHealth is true, the alias record inherits the health of the referenced Amazon Web Services resource. such as an ELB load balancer. For more information, see EvaluateTargetHealth.

  • If you include HealthCheckConfig and then use the service to register an instance that creates an alias record, Route 53 doesn't create the health check.

Charges for health checks

Health checks are basic Route 53 health checks that monitor an Amazon Web Services endpoint. For information about pricing for health checks, see Amazon Route 53 Pricing.

See Also:

AWS API Reference

Definition at line 74 of file HealthCheckConfig.h.

Constructor & Destructor Documentation

◆ HealthCheckConfig() [1/2]

Aws::ServiceDiscovery::Model::HealthCheckConfig::HealthCheckConfig ( )

◆ HealthCheckConfig() [2/2]

Aws::ServiceDiscovery::Model::HealthCheckConfig::HealthCheckConfig ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ FailureThresholdHasBeenSet()

bool Aws::ServiceDiscovery::Model::HealthCheckConfig::FailureThresholdHasBeenSet ( ) const
inline

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. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

Definition at line 325 of file HealthCheckConfig.h.

◆ GetFailureThreshold()

int Aws::ServiceDiscovery::Model::HealthCheckConfig::GetFailureThreshold ( ) const
inline

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. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

Definition at line 315 of file HealthCheckConfig.h.

◆ GetResourcePath()

const Aws::String& Aws::ServiceDiscovery::Model::HealthCheckConfig::GetResourcePath ( ) const
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 220 of file HealthCheckConfig.h.

◆ GetType()

const HealthCheckType& Aws::ServiceDiscovery::Model::HealthCheckConfig::GetType ( ) const
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 102 of file HealthCheckConfig.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::ServiceDiscovery::Model::HealthCheckConfig::Jsonize ( ) const

◆ operator=()

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ResourcePathHasBeenSet()

bool Aws::ServiceDiscovery::Model::HealthCheckConfig::ResourcePathHasBeenSet ( ) const
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 232 of file HealthCheckConfig.h.

◆ SetFailureThreshold()

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetFailureThreshold ( int  value)
inline

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. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

Definition at line 335 of file HealthCheckConfig.h.

◆ SetResourcePath() [1/3]

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetResourcePath ( Aws::String &&  value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 256 of file HealthCheckConfig.h.

◆ SetResourcePath() [2/3]

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetResourcePath ( const Aws::String value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 244 of file HealthCheckConfig.h.

◆ SetResourcePath() [3/3]

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetResourcePath ( const char *  value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 268 of file HealthCheckConfig.h.

◆ SetType() [1/2]

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetType ( const HealthCheckType value)
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 144 of file HealthCheckConfig.h.

◆ SetType() [2/2]

void Aws::ServiceDiscovery::Model::HealthCheckConfig::SetType ( HealthCheckType &&  value)
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 165 of file HealthCheckConfig.h.

◆ TypeHasBeenSet()

bool Aws::ServiceDiscovery::Model::HealthCheckConfig::TypeHasBeenSet ( ) const
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 123 of file HealthCheckConfig.h.

◆ WithFailureThreshold()

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithFailureThreshold ( int  value)
inline

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. For more information, see How Route 53 Determines Whether an Endpoint Is Healthy in the Route 53 Developer Guide.

Definition at line 345 of file HealthCheckConfig.h.

◆ WithResourcePath() [1/3]

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithResourcePath ( Aws::String &&  value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 292 of file HealthCheckConfig.h.

◆ WithResourcePath() [2/3]

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithResourcePath ( const Aws::String value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 280 of file HealthCheckConfig.h.

◆ WithResourcePath() [3/3]

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithResourcePath ( const char *  value)
inline

The path that you want Route 53 to request when performing health checks. 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.

Definition at line 304 of file HealthCheckConfig.h.

◆ WithType() [1/2]

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithType ( const HealthCheckType value)
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 186 of file HealthCheckConfig.h.

◆ WithType() [2/2]

HealthCheckConfig& Aws::ServiceDiscovery::Model::HealthCheckConfig::WithType ( HealthCheckType &&  value)
inline

The type of health check that you want to create, which indicates how Route 53 determines whether an endpoint is healthy.

You can't change the value of Type after you create a health check.

You can create the following types of health checks:

  • HTTP: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTP request and waits for an HTTP status code of 200 or greater and less than 400.

  • HTTPS: Route 53 tries to establish a TCP connection. If successful, Route 53 submits an HTTPS request and waits for an HTTP status code of 200 or greater and less than 400.

    If you specify HTTPS for the value of Type, the endpoint must support TLS v1.0 or later.

  • TCP: Route 53 tries to establish a TCP connection.

    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.

Definition at line 207 of file HealthCheckConfig.h.


The documentation for this class was generated from the following file: