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	awscc.route53.health_checks

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
health_check_id	string
region	string	AWS region.

For more information, see AWS::Route53::HealthCheck.

Methods

Name	Resource	Accessible by	Required Params
create_resource	health_checks	INSERT	HealthCheckConfig, region
delete_resource	health_checks	DELETE	Identifier, region
update_resource	health_checks	UPDATE	Identifier, PatchDocument, region
list_resources	health_checks_list_only	SELECT	region
get_resource	health_checks	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual health_check.

SELECT
  region,
  health_check_id,
  health_check_config,
  health_check_tags
FROM awscc.route53.health_checks
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ health_check_id }}';

list (identifiers only)

Lists all health_checks in a region.

SELECT
  region,
  health_check_id
FROM awscc.route53.health_checks_list_only
WHERE
  region = 'us-east-1';

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 awscc.route53.health_checks (
  HealthCheckConfig,
  region
)
SELECT
  '{{ health_check_config }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.route53.health_checks (
  HealthCheckConfig,
  HealthCheckTags,
  region
)
SELECT
  '{{ health_check_config }}',
  '{{ health_check_tags }}',
  '{{ 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: health_check_config
        value:
          alarm_identifier:
            name: '{{ name }}'
            region: '{{ region }}'
          child_health_checks:
            - '{{ child_health_checks[0] }}'
          enable_sn_i: '{{ enable_sn_i }}'
          failure_threshold: '{{ failure_threshold }}'
          fully_qualified_domain_name: '{{ fully_qualified_domain_name }}'
          health_threshold: '{{ health_threshold }}'
          insufficient_data_health_status: '{{ insufficient_data_health_status }}'
          inverted: '{{ inverted }}'
          ip_address: '{{ ip_address }}'
          measure_latency: '{{ measure_latency }}'
          port: '{{ port }}'
          regions:
            - '{{ regions[0] }}'
          request_interval: '{{ request_interval }}'
          resource_path: '{{ resource_path }}'
          search_string: '{{ search_string }}'
          routing_control_arn: '{{ routing_control_arn }}'
          type: '{{ type }}'
      - name: health_check_tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.route53.health_checks
SET PatchDocument = string('{{ {
    "HealthCheckTags": health_check_tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ health_check_id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.route53.health_checks
WHERE
  Identifier = '{{ health_check_id }}' 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