health_checks

Creates, updates, deletes or gets a health_check resource or lists health_checks in a region

Overview

Name	health_checks
Type	Resource
Description	Resource schema for AWS::Route53::HealthCheck.
Id	aws.route53.health_checks

Fields

Name	Datatype	Description
health_check_id	string
health_check_config	object	A complex type that contains information about the health check.
health_check_tags	array	An array of key-value pairs to apply to this resource.
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	HealthCheckConfig, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all health_checks in a region.

SELECT
region,
health_check_id,
health_check_config,
health_check_tags
FROM aws.route53.health_checks
;

Gets all properties from an individual health_check.

SELECT
region,
health_check_id,
health_check_config,
health_check_tags
FROM aws.route53.health_checks
WHERE data__Identifier = '<HealthCheckId>';

INSERT example

Use the following StackQL query and manifest file to create a new health_check resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.route53.health_checks (
 HealthCheckConfig,
 region
)
SELECT 
'{{ HealthCheckConfig }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.route53.health_checks (
 HealthCheckConfig,
 HealthCheckTags,
 region
)
SELECT 
 '{{ HealthCheckConfig }}',
 '{{ HealthCheckTags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: health_check
    props:
      - name: HealthCheckConfig
        value:
          AlarmIdentifier:
            Name: '{{ Name }}'
            Region: '{{ Region }}'
          ChildHealthChecks:
            - '{{ ChildHealthChecks[0] }}'
          EnableSNI: '{{ EnableSNI }}'
          FailureThreshold: '{{ FailureThreshold }}'
          FullyQualifiedDomainName: '{{ FullyQualifiedDomainName }}'
          HealthThreshold: '{{ HealthThreshold }}'
          InsufficientDataHealthStatus: '{{ InsufficientDataHealthStatus }}'
          Inverted: '{{ Inverted }}'
          IPAddress: '{{ IPAddress }}'
          MeasureLatency: '{{ MeasureLatency }}'
          Port: '{{ Port }}'
          Regions:
            - '{{ Regions[0] }}'
          RequestInterval: '{{ RequestInterval }}'
          ResourcePath: '{{ ResourcePath }}'
          SearchString: '{{ SearchString }}'
          RoutingControlArn: '{{ RoutingControlArn }}'
          Type: '{{ Type }}'
      - name: HealthCheckTags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.route53.health_checks
WHERE data__Identifier = '<HealthCheckId>'
AND region = 'us-east-1';

Permissions

To operate on the health_checks resource, the following permissions are required:

Create

route53:CreateHealthCheck,
route53:ChangeTagsForResource,
cloudwatch:DescribeAlarms,
route53-recovery-control-config:DescribeRoutingControl

Read

route53:GetHealthCheck,
route53:ListTagsForResource

Update

route53:UpdateHealthCheck,
route53:ChangeTagsForResource,
route53:ListTagsForResource,
cloudwatch:DescribeAlarms

Delete

route53:DeleteHealthCheck

List

route53:ListHealthChecks,
route53:ListTagsForResource