AWS SDK for C++  1.8.51
AWS SDK for C++
Public Member Functions | List of all members
Aws::Route53::Model::UpdateHealthCheckRequest Class Reference

#include <UpdateHealthCheckRequest.h>

+ Inheritance diagram for Aws::Route53::Model::UpdateHealthCheckRequest:

Public Member Functions

 UpdateHealthCheckRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
const Aws::StringGetHealthCheckId () const
 
bool HealthCheckIdHasBeenSet () const
 
void SetHealthCheckId (const Aws::String &value)
 
void SetHealthCheckId (Aws::String &&value)
 
void SetHealthCheckId (const char *value)
 
UpdateHealthCheckRequestWithHealthCheckId (const Aws::String &value)
 
UpdateHealthCheckRequestWithHealthCheckId (Aws::String &&value)
 
UpdateHealthCheckRequestWithHealthCheckId (const char *value)
 
long long GetHealthCheckVersion () const
 
bool HealthCheckVersionHasBeenSet () const
 
void SetHealthCheckVersion (long long value)
 
UpdateHealthCheckRequestWithHealthCheckVersion (long long value)
 
const Aws::StringGetIPAddress () const
 
bool IPAddressHasBeenSet () const
 
void SetIPAddress (const Aws::String &value)
 
void SetIPAddress (Aws::String &&value)
 
void SetIPAddress (const char *value)
 
UpdateHealthCheckRequestWithIPAddress (const Aws::String &value)
 
UpdateHealthCheckRequestWithIPAddress (Aws::String &&value)
 
UpdateHealthCheckRequestWithIPAddress (const char *value)
 
int GetPort () const
 
bool PortHasBeenSet () const
 
void SetPort (int value)
 
UpdateHealthCheckRequestWithPort (int value)
 
const Aws::StringGetResourcePath () const
 
bool ResourcePathHasBeenSet () const
 
void SetResourcePath (const Aws::String &value)
 
void SetResourcePath (Aws::String &&value)
 
void SetResourcePath (const char *value)
 
UpdateHealthCheckRequestWithResourcePath (const Aws::String &value)
 
UpdateHealthCheckRequestWithResourcePath (Aws::String &&value)
 
UpdateHealthCheckRequestWithResourcePath (const char *value)
 
const Aws::StringGetFullyQualifiedDomainName () const
 
bool FullyQualifiedDomainNameHasBeenSet () const
 
void SetFullyQualifiedDomainName (const Aws::String &value)
 
void SetFullyQualifiedDomainName (Aws::String &&value)
 
void SetFullyQualifiedDomainName (const char *value)
 
UpdateHealthCheckRequestWithFullyQualifiedDomainName (const Aws::String &value)
 
UpdateHealthCheckRequestWithFullyQualifiedDomainName (Aws::String &&value)
 
UpdateHealthCheckRequestWithFullyQualifiedDomainName (const char *value)
 
const Aws::StringGetSearchString () const
 
bool SearchStringHasBeenSet () const
 
void SetSearchString (const Aws::String &value)
 
void SetSearchString (Aws::String &&value)
 
void SetSearchString (const char *value)
 
UpdateHealthCheckRequestWithSearchString (const Aws::String &value)
 
UpdateHealthCheckRequestWithSearchString (Aws::String &&value)
 
UpdateHealthCheckRequestWithSearchString (const char *value)
 
int GetFailureThreshold () const
 
bool FailureThresholdHasBeenSet () const
 
void SetFailureThreshold (int value)
 
UpdateHealthCheckRequestWithFailureThreshold (int value)
 
bool GetInverted () const
 
bool InvertedHasBeenSet () const
 
void SetInverted (bool value)
 
UpdateHealthCheckRequestWithInverted (bool value)
 
bool GetDisabled () const
 
bool DisabledHasBeenSet () const
 
void SetDisabled (bool value)
 
UpdateHealthCheckRequestWithDisabled (bool value)
 
int GetHealthThreshold () const
 
bool HealthThresholdHasBeenSet () const
 
void SetHealthThreshold (int value)
 
UpdateHealthCheckRequestWithHealthThreshold (int value)
 
const Aws::Vector< Aws::String > & GetChildHealthChecks () const
 
bool ChildHealthChecksHasBeenSet () const
 
void SetChildHealthChecks (const Aws::Vector< Aws::String > &value)
 
void SetChildHealthChecks (Aws::Vector< Aws::String > &&value)
 
UpdateHealthCheckRequestWithChildHealthChecks (const Aws::Vector< Aws::String > &value)
 
UpdateHealthCheckRequestWithChildHealthChecks (Aws::Vector< Aws::String > &&value)
 
UpdateHealthCheckRequestAddChildHealthChecks (const Aws::String &value)
 
UpdateHealthCheckRequestAddChildHealthChecks (Aws::String &&value)
 
UpdateHealthCheckRequestAddChildHealthChecks (const char *value)
 
bool GetEnableSNI () const
 
bool EnableSNIHasBeenSet () const
 
void SetEnableSNI (bool value)
 
UpdateHealthCheckRequestWithEnableSNI (bool value)
 
const Aws::Vector< HealthCheckRegion > & GetRegions () const
 
bool RegionsHasBeenSet () const
 
void SetRegions (const Aws::Vector< HealthCheckRegion > &value)
 
void SetRegions (Aws::Vector< HealthCheckRegion > &&value)
 
UpdateHealthCheckRequestWithRegions (const Aws::Vector< HealthCheckRegion > &value)
 
UpdateHealthCheckRequestWithRegions (Aws::Vector< HealthCheckRegion > &&value)
 
UpdateHealthCheckRequestAddRegions (const HealthCheckRegion &value)
 
UpdateHealthCheckRequestAddRegions (HealthCheckRegion &&value)
 
const AlarmIdentifierGetAlarmIdentifier () const
 
bool AlarmIdentifierHasBeenSet () const
 
void SetAlarmIdentifier (const AlarmIdentifier &value)
 
void SetAlarmIdentifier (AlarmIdentifier &&value)
 
UpdateHealthCheckRequestWithAlarmIdentifier (const AlarmIdentifier &value)
 
UpdateHealthCheckRequestWithAlarmIdentifier (AlarmIdentifier &&value)
 
const InsufficientDataHealthStatusGetInsufficientDataHealthStatus () const
 
bool InsufficientDataHealthStatusHasBeenSet () const
 
void SetInsufficientDataHealthStatus (const InsufficientDataHealthStatus &value)
 
void SetInsufficientDataHealthStatus (InsufficientDataHealthStatus &&value)
 
UpdateHealthCheckRequestWithInsufficientDataHealthStatus (const InsufficientDataHealthStatus &value)
 
UpdateHealthCheckRequestWithInsufficientDataHealthStatus (InsufficientDataHealthStatus &&value)
 
const Aws::Vector< ResettableElementName > & GetResetElements () const
 
bool ResetElementsHasBeenSet () const
 
void SetResetElements (const Aws::Vector< ResettableElementName > &value)
 
void SetResetElements (Aws::Vector< ResettableElementName > &&value)
 
UpdateHealthCheckRequestWithResetElements (const Aws::Vector< ResettableElementName > &value)
 
UpdateHealthCheckRequestWithResetElements (Aws::Vector< ResettableElementName > &&value)
 
UpdateHealthCheckRequestAddResetElements (const ResettableElementName &value)
 
UpdateHealthCheckRequestAddResetElements (ResettableElementName &&value)
 
- Public Member Functions inherited from Aws::Route53::Route53Request
virtual ~Route53Request ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::Route53::Route53Request
virtual Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const
 
- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

A complex type that contains information about a request to update a health check.

See Also:

AWS API Reference

Definition at line 30 of file UpdateHealthCheckRequest.h.

Constructor & Destructor Documentation

◆ UpdateHealthCheckRequest()

Aws::Route53::Model::UpdateHealthCheckRequest::UpdateHealthCheckRequest ( )

Member Function Documentation

◆ AddChildHealthChecks() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddChildHealthChecks ( const Aws::String value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1402 of file UpdateHealthCheckRequest.h.

◆ AddChildHealthChecks() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddChildHealthChecks ( Aws::String &&  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1409 of file UpdateHealthCheckRequest.h.

◆ AddChildHealthChecks() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddChildHealthChecks ( const char *  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1416 of file UpdateHealthCheckRequest.h.

◆ AddRegions() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddRegions ( const HealthCheckRegion value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1563 of file UpdateHealthCheckRequest.h.

◆ AddRegions() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddRegions ( HealthCheckRegion &&  value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1570 of file UpdateHealthCheckRequest.h.

◆ AddResetElements() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddResetElements ( const ResettableElementName value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1819 of file UpdateHealthCheckRequest.h.

◆ AddResetElements() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::AddResetElements ( ResettableElementName &&  value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1837 of file UpdateHealthCheckRequest.h.

◆ AlarmIdentifierHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::AlarmIdentifierHasBeenSet ( ) const
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1585 of file UpdateHealthCheckRequest.h.

◆ ChildHealthChecksHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::ChildHealthChecksHasBeenSet ( ) const
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1367 of file UpdateHealthCheckRequest.h.

◆ DisabledHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::DisabledHasBeenSet ( ) const
inline

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

Definition at line 1257 of file UpdateHealthCheckRequest.h.

◆ EnableSNIHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::EnableSNIHasBeenSet ( ) const
inline

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

Definition at line 1465 of file UpdateHealthCheckRequest.h.

◆ FailureThresholdHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::FailureThresholdHasBeenSet ( ) const
inline

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

Definition at line 1167 of file UpdateHealthCheckRequest.h.

◆ FullyQualifiedDomainNameHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::FullyQualifiedDomainNameHasBeenSet ( ) const
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 735 of file UpdateHealthCheckRequest.h.

◆ GetAlarmIdentifier()

const AlarmIdentifier& Aws::Route53::Model::UpdateHealthCheckRequest::GetAlarmIdentifier ( ) const
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1578 of file UpdateHealthCheckRequest.h.

◆ GetChildHealthChecks()

const Aws::Vector<Aws::String>& Aws::Route53::Model::UpdateHealthCheckRequest::GetChildHealthChecks ( ) const
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1360 of file UpdateHealthCheckRequest.h.

◆ GetDisabled()

bool Aws::Route53::Model::UpdateHealthCheckRequest::GetDisabled ( ) const
inline

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

Definition at line 1238 of file UpdateHealthCheckRequest.h.

◆ GetEnableSNI()

bool Aws::Route53::Model::UpdateHealthCheckRequest::GetEnableSNI ( ) const
inline

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

Definition at line 1441 of file UpdateHealthCheckRequest.h.

◆ GetFailureThreshold()

int Aws::Route53::Model::UpdateHealthCheckRequest::GetFailureThreshold ( ) const
inline

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

Definition at line 1156 of file UpdateHealthCheckRequest.h.

◆ GetFullyQualifiedDomainName()

const Aws::String& Aws::Route53::Model::UpdateHealthCheckRequest::GetFullyQualifiedDomainName ( ) const
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 679 of file UpdateHealthCheckRequest.h.

◆ GetHealthCheckId()

const Aws::String& Aws::Route53::Model::UpdateHealthCheckRequest::GetHealthCheckId ( ) const
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 49 of file UpdateHealthCheckRequest.h.

◆ GetHealthCheckVersion()

long long Aws::Route53::Model::UpdateHealthCheckRequest::GetHealthCheckVersion ( ) const
inline

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

Definition at line 117 of file UpdateHealthCheckRequest.h.

◆ GetHealthThreshold()

int Aws::Route53::Model::UpdateHealthCheckRequest::GetHealthThreshold ( ) const
inline

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

Definition at line 1310 of file UpdateHealthCheckRequest.h.

◆ GetInsufficientDataHealthStatus()

const InsufficientDataHealthStatus& Aws::Route53::Model::UpdateHealthCheckRequest::GetInsufficientDataHealthStatus ( ) const
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1627 of file UpdateHealthCheckRequest.h.

◆ GetInverted()

bool Aws::Route53::Model::UpdateHealthCheckRequest::GetInverted ( ) const
inline

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

Definition at line 1197 of file UpdateHealthCheckRequest.h.

◆ GetIPAddress()

const Aws::String& Aws::Route53::Model::UpdateHealthCheckRequest::GetIPAddress ( ) const
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 214 of file UpdateHealthCheckRequest.h.

◆ GetPort()

int Aws::Route53::Model::UpdateHealthCheckRequest::GetPort ( ) const
inline

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

Definition at line 517 of file UpdateHealthCheckRequest.h.

◆ GetRegions()

const Aws::Vector<HealthCheckRegion>& Aws::Route53::Model::UpdateHealthCheckRequest::GetRegions ( ) const
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1521 of file UpdateHealthCheckRequest.h.

◆ GetResetElements()

const Aws::Vector<ResettableElementName>& Aws::Route53::Model::UpdateHealthCheckRequest::GetResetElements ( ) const
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1711 of file UpdateHealthCheckRequest.h.

◆ GetResourcePath()

const Aws::String& Aws::Route53::Model::UpdateHealthCheckRequest::GetResourcePath ( ) const
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 552 of file UpdateHealthCheckRequest.h.

◆ GetSearchString()

const Aws::String& Aws::Route53::Model::UpdateHealthCheckRequest::GetSearchString ( ) const
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1081 of file UpdateHealthCheckRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::Route53::Model::UpdateHealthCheckRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 39 of file UpdateHealthCheckRequest.h.

◆ HealthCheckIdHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::HealthCheckIdHasBeenSet ( ) const
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 56 of file UpdateHealthCheckRequest.h.

◆ HealthCheckVersionHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::HealthCheckVersionHasBeenSet ( ) const
inline

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

Definition at line 135 of file UpdateHealthCheckRequest.h.

◆ HealthThresholdHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::HealthThresholdHasBeenSet ( ) const
inline

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

Definition at line 1324 of file UpdateHealthCheckRequest.h.

◆ InsufficientDataHealthStatusHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::InsufficientDataHealthStatusHasBeenSet ( ) const
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1640 of file UpdateHealthCheckRequest.h.

◆ InvertedHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::InvertedHasBeenSet ( ) const
inline

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

Definition at line 1204 of file UpdateHealthCheckRequest.h.

◆ IPAddressHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::IPAddressHasBeenSet ( ) const
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 256 of file UpdateHealthCheckRequest.h.

◆ PortHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::PortHasBeenSet ( ) const
inline

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

Definition at line 525 of file UpdateHealthCheckRequest.h.

◆ RegionsHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::RegionsHasBeenSet ( ) const
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1528 of file UpdateHealthCheckRequest.h.

◆ ResetElementsHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::ResetElementsHasBeenSet ( ) const
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1729 of file UpdateHealthCheckRequest.h.

◆ ResourcePathHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::ResourcePathHasBeenSet ( ) const
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 562 of file UpdateHealthCheckRequest.h.

◆ SearchStringHasBeenSet()

bool Aws::Route53::Model::UpdateHealthCheckRequest::SearchStringHasBeenSet ( ) const
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1090 of file UpdateHealthCheckRequest.h.

◆ SerializePayload()

Aws::String Aws::Route53::Model::UpdateHealthCheckRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAlarmIdentifier() [1/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetAlarmIdentifier ( const AlarmIdentifier value)
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1592 of file UpdateHealthCheckRequest.h.

◆ SetAlarmIdentifier() [2/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetAlarmIdentifier ( AlarmIdentifier &&  value)
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1599 of file UpdateHealthCheckRequest.h.

◆ SetChildHealthChecks() [1/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetChildHealthChecks ( const Aws::Vector< Aws::String > &  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1374 of file UpdateHealthCheckRequest.h.

◆ SetChildHealthChecks() [2/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetChildHealthChecks ( Aws::Vector< Aws::String > &&  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1381 of file UpdateHealthCheckRequest.h.

◆ SetDisabled()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetDisabled ( bool  value)
inline

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

Definition at line 1276 of file UpdateHealthCheckRequest.h.

◆ SetEnableSNI()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetEnableSNI ( bool  value)
inline

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

Definition at line 1489 of file UpdateHealthCheckRequest.h.

◆ SetFailureThreshold()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetFailureThreshold ( int  value)
inline

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

Definition at line 1178 of file UpdateHealthCheckRequest.h.

◆ SetFullyQualifiedDomainName() [1/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetFullyQualifiedDomainName ( const Aws::String value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 791 of file UpdateHealthCheckRequest.h.

◆ SetFullyQualifiedDomainName() [2/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetFullyQualifiedDomainName ( Aws::String &&  value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 847 of file UpdateHealthCheckRequest.h.

◆ SetFullyQualifiedDomainName() [3/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetFullyQualifiedDomainName ( const char *  value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 903 of file UpdateHealthCheckRequest.h.

◆ SetHealthCheckId() [1/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetHealthCheckId ( const Aws::String value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 63 of file UpdateHealthCheckRequest.h.

◆ SetHealthCheckId() [2/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetHealthCheckId ( Aws::String &&  value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 70 of file UpdateHealthCheckRequest.h.

◆ SetHealthCheckId() [3/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetHealthCheckId ( const char *  value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 77 of file UpdateHealthCheckRequest.h.

◆ SetHealthCheckVersion()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetHealthCheckVersion ( long long  value)
inline

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

Definition at line 153 of file UpdateHealthCheckRequest.h.

◆ SetHealthThreshold()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetHealthThreshold ( int  value)
inline

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

Definition at line 1338 of file UpdateHealthCheckRequest.h.

◆ SetInsufficientDataHealthStatus() [1/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetInsufficientDataHealthStatus ( const InsufficientDataHealthStatus value)
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1653 of file UpdateHealthCheckRequest.h.

◆ SetInsufficientDataHealthStatus() [2/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetInsufficientDataHealthStatus ( InsufficientDataHealthStatus &&  value)
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1666 of file UpdateHealthCheckRequest.h.

◆ SetInverted()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetInverted ( bool  value)
inline

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

Definition at line 1211 of file UpdateHealthCheckRequest.h.

◆ SetIPAddress() [1/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetIPAddress ( const Aws::String value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 298 of file UpdateHealthCheckRequest.h.

◆ SetIPAddress() [2/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetIPAddress ( Aws::String &&  value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 340 of file UpdateHealthCheckRequest.h.

◆ SetIPAddress() [3/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetIPAddress ( const char *  value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 382 of file UpdateHealthCheckRequest.h.

◆ SetPort()

void Aws::Route53::Model::UpdateHealthCheckRequest::SetPort ( int  value)
inline

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

Definition at line 533 of file UpdateHealthCheckRequest.h.

◆ SetRegions() [1/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetRegions ( const Aws::Vector< HealthCheckRegion > &  value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1535 of file UpdateHealthCheckRequest.h.

◆ SetRegions() [2/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetRegions ( Aws::Vector< HealthCheckRegion > &&  value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1542 of file UpdateHealthCheckRequest.h.

◆ SetResetElements() [1/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetResetElements ( const Aws::Vector< ResettableElementName > &  value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1747 of file UpdateHealthCheckRequest.h.

◆ SetResetElements() [2/2]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetResetElements ( Aws::Vector< ResettableElementName > &&  value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1765 of file UpdateHealthCheckRequest.h.

◆ SetResourcePath() [1/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetResourcePath ( const Aws::String value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 572 of file UpdateHealthCheckRequest.h.

◆ SetResourcePath() [2/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetResourcePath ( Aws::String &&  value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 582 of file UpdateHealthCheckRequest.h.

◆ SetResourcePath() [3/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetResourcePath ( const char *  value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 592 of file UpdateHealthCheckRequest.h.

◆ SetSearchString() [1/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetSearchString ( const Aws::String value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1099 of file UpdateHealthCheckRequest.h.

◆ SetSearchString() [2/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetSearchString ( Aws::String &&  value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1108 of file UpdateHealthCheckRequest.h.

◆ SetSearchString() [3/3]

void Aws::Route53::Model::UpdateHealthCheckRequest::SetSearchString ( const char *  value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1117 of file UpdateHealthCheckRequest.h.

◆ WithAlarmIdentifier() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithAlarmIdentifier ( const AlarmIdentifier value)
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1606 of file UpdateHealthCheckRequest.h.

◆ WithAlarmIdentifier() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithAlarmIdentifier ( AlarmIdentifier &&  value)
inline

A complex type that identifies the CloudWatch alarm that you want Amazon Route 53 health checkers to use to determine whether the specified health check is healthy.

Definition at line 1613 of file UpdateHealthCheckRequest.h.

◆ WithChildHealthChecks() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithChildHealthChecks ( const Aws::Vector< Aws::String > &  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1388 of file UpdateHealthCheckRequest.h.

◆ WithChildHealthChecks() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithChildHealthChecks ( Aws::Vector< Aws::String > &&  value)
inline

A complex type that contains one ChildHealthCheck element for each health check that you want to associate with a CALCULATED health check.

Definition at line 1395 of file UpdateHealthCheckRequest.h.

◆ WithDisabled()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithDisabled ( bool  value)
inline

Stops Route 53 from performing health checks. When you disable a health check, here's what happens:

  • Health checks that check the health of endpoints: Route 53 stops submitting requests to your application, server, or other resource.

  • Calculated health checks: Route 53 stops aggregating the status of the referenced health checks.

  • Health checks that monitor CloudWatch alarms: Route 53 stops monitoring the corresponding CloudWatch metrics.

After you disable a health check, Route 53 considers the status of the health check to always be healthy. If you configured DNS failover, Route 53 continues to route traffic to the corresponding resources. If you want to stop routing traffic to a resource, change the value of Inverted.

Charges for a health check still apply when the health check is disabled. For more information, see Amazon Route 53 Pricing.

Definition at line 1295 of file UpdateHealthCheckRequest.h.

◆ WithEnableSNI()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithEnableSNI ( bool  value)
inline

Specify whether you want Amazon Route 53 to send the value of FullyQualifiedDomainName to the endpoint in the client_hello message during TLS negotiation. This allows the endpoint to respond to HTTPS health check requests with the applicable SSL/TLS certificate.

Some endpoints require that HTTPS requests include the host name in the client_hello message. If you don't enable SNI, the status of the health check will be SSL alert handshake_failure. A health check can also have that status for other reasons. If SNI is enabled and you're still getting the error, check the SSL/TLS configuration on your endpoint and confirm that your certificate is valid.

The SSL/TLS certificate on your endpoint includes a domain name in the Common Name field and possibly several more in the Subject Alternative Names field. One of the domain names in the certificate should match the value that you specify for FullyQualifiedDomainName. If the endpoint responds to the client_hello message with a certificate that does not include the domain name that you specified in FullyQualifiedDomainName, a health checker will retry the handshake. In the second attempt, the health checker will omit FullyQualifiedDomainName from the client_hello message.

Definition at line 1513 of file UpdateHealthCheckRequest.h.

◆ WithFailureThreshold()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithFailureThreshold ( int  value)
inline

The number of consecutive health checks that an endpoint must pass or fail for Amazon Route 53 to change the current status of the endpoint from unhealthy to healthy or vice versa. For more information, see How Amazon Route 53 Determines Whether an Endpoint Is Healthy in the Amazon Route 53 Developer Guide.

If you don't specify a value for FailureThreshold, the default value is three health checks.

Definition at line 1189 of file UpdateHealthCheckRequest.h.

◆ WithFullyQualifiedDomainName() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithFullyQualifiedDomainName ( const Aws::String value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 959 of file UpdateHealthCheckRequest.h.

◆ WithFullyQualifiedDomainName() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithFullyQualifiedDomainName ( Aws::String &&  value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 1015 of file UpdateHealthCheckRequest.h.

◆ WithFullyQualifiedDomainName() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithFullyQualifiedDomainName ( const char *  value)
inline

Amazon Route 53 behavior depends on whether you specify a value for IPAddress.

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

If you specify a value for IPAddress:

Route 53 sends health check requests to the specified IPv4 or IPv6 address and passes the value of FullyQualifiedDomainName in the Host header for all health checks except TCP health checks. This is typically the fully qualified DNS name of the endpoint on which you want Route 53 to perform health checks.

When Route 53 checks the health of an endpoint, here is how it constructs the Host header:

  • If you specify a value of 80 for Port and HTTP or HTTP_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify a value of 443 for Port and HTTPS or HTTPS_STR_MATCH for Type, Route 53 passes the value of FullyQualifiedDomainName to the endpoint in the Host header.

  • If you specify another value for Port and any value except TCP for Type, Route 53 passes FullyQualifiedDomainName:Port to the endpoint in the Host header.

If you don't specify a value for FullyQualifiedDomainName, Route 53 substitutes the value of IPAddress in the Host header in each of the above cases.

If you don't specify a value for IPAddress:

If you don't specify a value for IPAddress, Route 53 sends a DNS request to the domain that you specify in FullyQualifiedDomainName at the interval you specify in RequestInterval. Using an IPv4 address that is returned by DNS, Route 53 then checks the health of the endpoint.

If you don't specify a value for IPAddress, Route 53 uses only IPv4 to send health checks to the endpoint. If there's no resource record set with a type of A for the name that you specify for FullyQualifiedDomainName, the health check fails with a "DNS resolution failed" error.

If you want to check the health of weighted, latency, or failover resource record sets and you choose to specify the endpoint only by FullyQualifiedDomainName, we recommend that you create a separate health check for each endpoint. For example, create a health check for each HTTP server that is serving content for www.example.com. For the value of FullyQualifiedDomainName, specify the domain name of the server (such as us-east-2-www.example.com), not the name of the resource record sets (www.example.com).

In this configuration, if the value of FullyQualifiedDomainName matches the name of the resource record sets and you then associate the health check with those resource record sets, health check results will be unpredictable.

In addition, if the value of Type is HTTP, HTTPS, HTTP_STR_MATCH, or HTTPS_STR_MATCH, Route 53 passes the value of FullyQualifiedDomainName in the Host header, as it does when you specify a value for IPAddress. If the value of Type is TCP, Route 53 doesn't pass a Host header.

Definition at line 1071 of file UpdateHealthCheckRequest.h.

◆ WithHealthCheckId() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithHealthCheckId ( const Aws::String value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 84 of file UpdateHealthCheckRequest.h.

◆ WithHealthCheckId() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithHealthCheckId ( Aws::String &&  value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 91 of file UpdateHealthCheckRequest.h.

◆ WithHealthCheckId() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithHealthCheckId ( const char *  value)
inline

The ID for the health check for which you want detailed information. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element.

Definition at line 98 of file UpdateHealthCheckRequest.h.

◆ WithHealthCheckVersion()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithHealthCheckVersion ( long long  value)
inline

A sequential counter that Amazon Route 53 sets to 1 when you create a health check and increments by 1 each time you update settings for the health check.

We recommend that you use GetHealthCheck or ListHealthChecks to get the current value of HealthCheckVersion for the health check that you want to update, and that you include that value in your UpdateHealthCheck request. This prevents Route 53 from overwriting an intervening update:

  • If the value in the UpdateHealthCheck request matches the value of HealthCheckVersion in the health check, Route 53 updates the health check with the new settings.

  • If the value of HealthCheckVersion in the health check is greater, the health check was changed after you got the version number. Route 53 does not update the health check, and it returns a HealthCheckVersionMismatch error.

Definition at line 171 of file UpdateHealthCheckRequest.h.

◆ WithHealthThreshold()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithHealthThreshold ( int  value)
inline

The number of child health checks that are associated with a CALCULATED health that Amazon Route 53 must consider healthy for the CALCULATED health check to be considered healthy. To specify the child health checks that you want to associate with a CALCULATED health check, use the ChildHealthChecks and ChildHealthCheck elements.

Note the following:

  • If you specify a number greater than the number of child health checks, Route 53 always considers this health check to be unhealthy.

  • If you specify 0, Route 53 always considers this health check to be healthy.

Definition at line 1352 of file UpdateHealthCheckRequest.h.

◆ WithInsufficientDataHealthStatus() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithInsufficientDataHealthStatus ( const InsufficientDataHealthStatus value)
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1679 of file UpdateHealthCheckRequest.h.

◆ WithInsufficientDataHealthStatus() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithInsufficientDataHealthStatus ( InsufficientDataHealthStatus &&  value)
inline

When CloudWatch has insufficient data about the metric to determine the alarm state, the status that you want Amazon Route 53 to assign to the health check:

  • Healthy: Route 53 considers the health check to be healthy.

  • Unhealthy: Route 53 considers the health check to be unhealthy.

  • LastKnownStatus: Route 53 uses the status of the health check from the last time CloudWatch had sufficient data to determine the alarm state. For new health checks that have no last known status, the default status for the health check is healthy.

Definition at line 1692 of file UpdateHealthCheckRequest.h.

◆ WithInverted()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithInverted ( bool  value)
inline

Specify whether you want Amazon Route 53 to invert the status of a health check, for example, to consider a health check unhealthy when it otherwise would be considered healthy.

Definition at line 1218 of file UpdateHealthCheckRequest.h.

◆ WithIPAddress() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithIPAddress ( const Aws::String value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 424 of file UpdateHealthCheckRequest.h.

◆ WithIPAddress() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithIPAddress ( Aws::String &&  value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 466 of file UpdateHealthCheckRequest.h.

◆ WithIPAddress() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithIPAddress ( const char *  value)
inline

The IPv4 or IPv6 IP address for the endpoint that you want Amazon Route 53 to perform health checks on. If you don't specify a value for IPAddress, Route 53 sends a DNS request to resolve the domain name that you specify in FullyQualifiedDomainName at the interval that you specify in RequestInterval. Using an IP address that is returned by DNS, Route 53 then checks the health of the endpoint.

Use one of the following formats for the value of IPAddress:

  • IPv4 address: four values between 0 and 255, separated by periods (.), for example, 192.0.2.44.

  • IPv6 address: eight groups of four hexadecimal values, separated by colons (:), for example, 2001:0db8:85a3:0000:0000:abcd:0001:2345. You can also shorten IPv6 addresses as described in RFC 5952, for example, 2001:db8:85a3::abcd:1:2345.

If the endpoint is an EC2 instance, we recommend that you create an Elastic IP address, associate it with your EC2 instance, and specify the Elastic IP address for IPAddress. This ensures that the IP address of your instance never changes. For more information, see the applicable documentation:

If a health check already has a value for IPAddress, you can change the value. However, you can't update an existing health check to add or remove the value of IPAddress.

For more information, see FullyQualifiedDomainName.

Constraints: Route 53 can't check the health of endpoints for which the IP address is in local, private, non-routable, or multicast ranges. For more information about IP addresses for which you can't create health checks, see the following documents:

Definition at line 508 of file UpdateHealthCheckRequest.h.

◆ WithPort()

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithPort ( int  value)
inline

The port on the endpoint that you want Amazon Route 53 to perform health checks on.

Don't specify a value for Port when you specify a value for Type of CLOUDWATCH_METRIC or CALCULATED.

Definition at line 541 of file UpdateHealthCheckRequest.h.

◆ WithRegions() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithRegions ( const Aws::Vector< HealthCheckRegion > &  value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1549 of file UpdateHealthCheckRequest.h.

◆ WithRegions() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithRegions ( Aws::Vector< HealthCheckRegion > &&  value)
inline

A complex type that contains one Region element for each region that you want Amazon Route 53 health checkers to check the specified endpoint from.

Definition at line 1556 of file UpdateHealthCheckRequest.h.

◆ WithResetElements() [1/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithResetElements ( const Aws::Vector< ResettableElementName > &  value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1783 of file UpdateHealthCheckRequest.h.

◆ WithResetElements() [2/2]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithResetElements ( Aws::Vector< ResettableElementName > &&  value)
inline

A complex type that contains one ResettableElementName element for each element that you want to reset to the default value. Valid values for ResettableElementName include the following:

Definition at line 1801 of file UpdateHealthCheckRequest.h.

◆ WithResourcePath() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithResourcePath ( const Aws::String value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 602 of file UpdateHealthCheckRequest.h.

◆ WithResourcePath() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithResourcePath ( Aws::String &&  value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 612 of file UpdateHealthCheckRequest.h.

◆ WithResourcePath() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithResourcePath ( const char *  value)
inline

The path that you want Amazon Route 53 to request when performing health checks. The path can be any value for which your endpoint will return an HTTP status code of 2xx or 3xx when the endpoint is healthy, for example the file /docs/route53-health-check.html. You can also include query string parameters, for example, /welcome.html?language=jp&login=y.

Specify this value only if you want to change it.

Definition at line 622 of file UpdateHealthCheckRequest.h.

◆ WithSearchString() [1/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithSearchString ( const Aws::String value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1126 of file UpdateHealthCheckRequest.h.

◆ WithSearchString() [2/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithSearchString ( Aws::String &&  value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1135 of file UpdateHealthCheckRequest.h.

◆ WithSearchString() [3/3]

UpdateHealthCheckRequest& Aws::Route53::Model::UpdateHealthCheckRequest::WithSearchString ( const char *  value)
inline

If the value of Type is HTTP_STR_MATCH or HTTPS_STR_MATCH, the string that you want Amazon Route 53 to search for in the response body from the specified resource. If the string appears in the response body, Route 53 considers the resource healthy. (You can't change the value of Type when you update a health check.)

Definition at line 1144 of file UpdateHealthCheckRequest.h.


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