health_check_status

Creates, updates, deletes, gets or lists a health_check_status resource.

Overview

Name	health_check_status
Type	Resource
Id	aws.route53.health_check_status

Fields

The following fields are returned by SELECT queries:

get_health_check_status

Name	Datatype	Description
health_check_observations	string	A list that contains one HealthCheckObservation element for each Amazon Route 53 health checker that is reporting a status about the health check endpoint.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_health_check_status	select	health_check_id, region		Gets status of a specified health check. This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
health_check_id	string	The ID for the health check that you want the current status for. When you created the health check, CreateHealthCheck returned the ID in the response, in the HealthCheckId element. If you want to check the status of a calculated health check, you must use the Amazon Route 53 console or the CloudWatch console. You can't use GetHealthCheckStatus to get the status of a calculated health check.
region	string	AWS region (default: us-east-1)

SELECT examples

get_health_check_status

Gets status of a specified health check. This API is intended for use during development to diagnose behavior. It doesn’t support production use-cases with high query rates that require immediate and actionable responses.

SELECT
health_check_observations
FROM aws.route53.health_check_status
WHERE health_check_id = '{{ health_check_id }}' -- required
AND region = '{{ region }}' -- required
;