HealthCheck

Provides a Route53 health check.

Example Usage

Connectivity and HTTP Status Code Check

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Route53.HealthCheck("example", new Aws.Route53.HealthCheckArgs
        {
            FailureThreshold = 5,
            Fqdn = "example.com",
            Port = 80,
            RequestInterval = 30,
            ResourcePath = "/",
            Tags = 
            {
                { "Name", "tf-test-health-check" },
            },
            Type = "HTTP",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/route53"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := route53.NewHealthCheck(ctx, "example", &route53.HealthCheckArgs{
            FailureThreshold: pulumi.Int(5),
            Fqdn:             pulumi.String("example.com"),
            Port:             pulumi.Int(80),
            RequestInterval:  pulumi.Int(30),
            ResourcePath:     pulumi.String("/"),
            Tags: pulumi.StringMap{
                "Name": pulumi.String("tf-test-health-check"),
            },
            Type: pulumi.String("HTTP"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.route53.HealthCheck("example",
    failure_threshold="5",
    fqdn="example.com",
    port=80,
    request_interval="30",
    resource_path="/",
    tags={
        "Name": "tf-test-health-check",
    },
    type="HTTP")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.route53.HealthCheck("example", {
    failureThreshold: 5,
    fqdn: "example.com",
    port: 80,
    requestInterval: 30,
    resourcePath: "/",
    tags: {
        Name: "tf-test-health-check",
    },
    type: "HTTP",
});

Connectivity and String Matching Check

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Route53.HealthCheck("example", new Aws.Route53.HealthCheckArgs
        {
            FailureThreshold = 5,
            Fqdn = "example.com",
            Port = 443,
            RequestInterval = 30,
            ResourcePath = "/",
            SearchString = "example",
            Type = "HTTPS_STR_MATCH",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/route53"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := route53.NewHealthCheck(ctx, "example", &route53.HealthCheckArgs{
            FailureThreshold: pulumi.Int(5),
            Fqdn:             pulumi.String("example.com"),
            Port:             pulumi.Int(443),
            RequestInterval:  pulumi.Int(30),
            ResourcePath:     pulumi.String("/"),
            SearchString:     pulumi.String("example"),
            Type:             pulumi.String("HTTPS_STR_MATCH"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.route53.HealthCheck("example",
    failure_threshold="5",
    fqdn="example.com",
    port=443,
    request_interval="30",
    resource_path="/",
    search_string="example",
    type="HTTPS_STR_MATCH")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.route53.HealthCheck("example", {
    failureThreshold: 5,
    fqdn: "example.com",
    port: 443,
    requestInterval: 30,
    resourcePath: "/",
    searchString: "example",
    type: "HTTPS_STR_MATCH",
});

CloudWatch Alarm Check

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var foobar = new Aws.CloudWatch.MetricAlarm("foobar", new Aws.CloudWatch.MetricAlarmArgs
        {
            AlarmDescription = "This metric monitors ec2 cpu utilization",
            ComparisonOperator = "GreaterThanOrEqualToThreshold",
            EvaluationPeriods = 2,
            MetricName = "CPUUtilization",
            Namespace = "AWS/EC2",
            Period = 120,
            Statistic = "Average",
            Threshold = 80,
        });
        var foo = new Aws.Route53.HealthCheck("foo", new Aws.Route53.HealthCheckArgs
        {
            CloudwatchAlarmName = foobar.Name,
            CloudwatchAlarmRegion = "us-west-2",
            InsufficientDataHealthStatus = "Healthy",
            Type = "CLOUDWATCH_METRIC",
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/cloudwatch"
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/route53"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        foobar, err := cloudwatch.NewMetricAlarm(ctx, "foobar", &cloudwatch.MetricAlarmArgs{
            AlarmDescription:   pulumi.String("This metric monitors ec2 cpu utilization"),
            ComparisonOperator: pulumi.String("GreaterThanOrEqualToThreshold"),
            EvaluationPeriods:  pulumi.Int(2),
            MetricName:         pulumi.String("CPUUtilization"),
            Namespace:          pulumi.String("AWS/EC2"),
            Period:             pulumi.Int(120),
            Statistic:          pulumi.String("Average"),
            Threshold:          pulumi.Float64(80),
        })
        if err != nil {
            return err
        }
        _, err = route53.NewHealthCheck(ctx, "foo", &route53.HealthCheckArgs{
            CloudwatchAlarmName:          foobar.Name,
            CloudwatchAlarmRegion:        pulumi.String("us-west-2"),
            InsufficientDataHealthStatus: pulumi.String("Healthy"),
            Type:                         pulumi.String("CLOUDWATCH_METRIC"),
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

foobar = aws.cloudwatch.MetricAlarm("foobar",
    alarm_description="This metric monitors ec2 cpu utilization",
    comparison_operator="GreaterThanOrEqualToThreshold",
    evaluation_periods="2",
    metric_name="CPUUtilization",
    namespace="AWS/EC2",
    period="120",
    statistic="Average",
    threshold="80")
foo = aws.route53.HealthCheck("foo",
    cloudwatch_alarm_name=foobar.name,
    cloudwatch_alarm_region="us-west-2",
    insufficient_data_health_status="Healthy",
    type="CLOUDWATCH_METRIC")

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const foobar = new aws.cloudwatch.MetricAlarm("foobar", {
    alarmDescription: "This metric monitors ec2 cpu utilization",
    comparisonOperator: "GreaterThanOrEqualToThreshold",
    evaluationPeriods: 2,
    metricName: "CPUUtilization",
    namespace: "AWS/EC2",
    period: 120,
    statistic: "Average",
    threshold: 80,
});
const foo = new aws.route53.HealthCheck("foo", {
    cloudwatchAlarmName: foobar.alarmName,
    cloudwatchAlarmRegion: "us-west-2",
    insufficientDataHealthStatus: "Healthy",
    type: "CLOUDWATCH_METRIC",
});

Create a HealthCheck Resource

new HealthCheck(name: string, args: HealthCheckArgs, opts?: CustomResourceOptions);

def HealthCheck(resource_name, opts=None, child_health_threshold=None, child_healthchecks=None, cloudwatch_alarm_name=None, cloudwatch_alarm_region=None, enable_sni=None, failure_threshold=None, fqdn=None, insufficient_data_health_status=None, invert_healthcheck=None, ip_address=None, measure_latency=None, port=None, reference_name=None, regions=None, request_interval=None, resource_path=None, search_string=None, tags=None, type=None, __props__=None);

func NewHealthCheck(ctx *Context, name string, args HealthCheckArgs, opts ...ResourceOption) (*HealthCheck, error)

public HealthCheck(string name, HealthCheckArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args HealthCheckArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

HealthCheck Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The HealthCheck resource accepts the following input properties:

Type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.
ChildHealthThreshold int: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
ChildHealthchecks List<string>: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
CloudwatchAlarmName string: The name of the CloudWatch alarm.
CloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
EnableSni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
FailureThreshold int: The number of consecutive health checks that an endpoint must pass or fail.
Fqdn string: The fully qualified domain name of the endpoint to be checked.
InsufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
InvertHealthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
IpAddress string: The IP address of the endpoint to be checked.
MeasureLatency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
Port int: The port of the endpoint to be checked.
ReferenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
Regions List<string>: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
RequestInterval int: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
ResourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
SearchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
Tags Dictionary<string, string>: A map of tags to assign to the health check.

Type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.
ChildHealthThreshold int: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
ChildHealthchecks []string: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
CloudwatchAlarmName string: The name of the CloudWatch alarm.
CloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
EnableSni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
FailureThreshold int: The number of consecutive health checks that an endpoint must pass or fail.
Fqdn string: The fully qualified domain name of the endpoint to be checked.
InsufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
InvertHealthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
IpAddress string: The IP address of the endpoint to be checked.
MeasureLatency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
Port int: The port of the endpoint to be checked.
ReferenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
Regions []string: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
RequestInterval int: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
ResourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
SearchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
Tags map[string]string: A map of tags to assign to the health check.

type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.
childHealthThreshold number: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
childHealthchecks string[]: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
cloudwatchAlarmName string: The name of the CloudWatch alarm.
cloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
enableSni boolean: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
failureThreshold number: The number of consecutive health checks that an endpoint must pass or fail.
fqdn string: The fully qualified domain name of the endpoint to be checked.
insufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
invertHealthcheck boolean: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
ipAddress string: The IP address of the endpoint to be checked.
measureLatency boolean: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
port number: The port of the endpoint to be checked.
referenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
regions string[]: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
requestInterval number: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
resourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
searchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
tags {[key: string]: string}: A map of tags to assign to the health check.

type str: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.
child_health_threshold float: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
child_healthchecks List[str]: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
cloudwatch_alarm_name str: The name of the CloudWatch alarm.
cloudwatch_alarm_region str: The CloudWatchRegion that the CloudWatch alarm was created in.
enable_sni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
failure_threshold float: The number of consecutive health checks that an endpoint must pass or fail.
fqdn str: The fully qualified domain name of the endpoint to be checked.
insufficient_data_health_status str: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
invert_healthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
ip_address str: The IP address of the endpoint to be checked.
measure_latency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
port float: The port of the endpoint to be checked.
reference_name str: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
regions List[str]: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
request_interval float: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
resource_path str: The path that you want Amazon Route 53 to request when performing health checks.
search_string str: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
tags Dict[str, str]: A map of tags to assign to the health check.

Outputs

All input properties are implicitly available as output properties. Additionally, the HealthCheck resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing HealthCheck Resource

Get an existing HealthCheck resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: HealthCheckState, opts?: CustomResourceOptions): HealthCheck

static get(resource_name, id, opts=None, child_health_threshold=None, child_healthchecks=None, cloudwatch_alarm_name=None, cloudwatch_alarm_region=None, enable_sni=None, failure_threshold=None, fqdn=None, insufficient_data_health_status=None, invert_healthcheck=None, ip_address=None, measure_latency=None, port=None, reference_name=None, regions=None, request_interval=None, resource_path=None, search_string=None, tags=None, type=None, __props__=None);

func GetHealthCheck(ctx *Context, name string, id IDInput, state *HealthCheckState, opts ...ResourceOption) (*HealthCheck, error)

public static HealthCheck Get(string name, Input<string> id, HealthCheckState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ChildHealthThreshold int: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
ChildHealthchecks List<string>: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
CloudwatchAlarmName string: The name of the CloudWatch alarm.
CloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
EnableSni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
FailureThreshold int: The number of consecutive health checks that an endpoint must pass or fail.
Fqdn string: The fully qualified domain name of the endpoint to be checked.
InsufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
InvertHealthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
IpAddress string: The IP address of the endpoint to be checked.
MeasureLatency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
Port int: The port of the endpoint to be checked.
ReferenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
Regions List<string>: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
RequestInterval int: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
ResourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
SearchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
Tags Dictionary<string, string>: A map of tags to assign to the health check.
Type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.

ChildHealthThreshold int: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
ChildHealthchecks []string: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
CloudwatchAlarmName string: The name of the CloudWatch alarm.
CloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
EnableSni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
FailureThreshold int: The number of consecutive health checks that an endpoint must pass or fail.
Fqdn string: The fully qualified domain name of the endpoint to be checked.
InsufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
InvertHealthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
IpAddress string: The IP address of the endpoint to be checked.
MeasureLatency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
Port int: The port of the endpoint to be checked.
ReferenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
Regions []string: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
RequestInterval int: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
ResourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
SearchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
Tags map[string]string: A map of tags to assign to the health check.
Type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.

childHealthThreshold number: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
childHealthchecks string[]: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
cloudwatchAlarmName string: The name of the CloudWatch alarm.
cloudwatchAlarmRegion string: The CloudWatchRegion that the CloudWatch alarm was created in.
enableSni boolean: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
failureThreshold number: The number of consecutive health checks that an endpoint must pass or fail.
fqdn string: The fully qualified domain name of the endpoint to be checked.
insufficientDataHealthStatus string: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
invertHealthcheck boolean: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
ipAddress string: The IP address of the endpoint to be checked.
measureLatency boolean: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
port number: The port of the endpoint to be checked.
referenceName string: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
regions string[]: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
requestInterval number: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
resourcePath string: The path that you want Amazon Route 53 to request when performing health checks.
searchString string: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
tags {[key: string]: string}: A map of tags to assign to the health check.
type string: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.

child_health_threshold float: The minimum number of child health checks that must be healthy for Route 53 to consider the parent health check to be healthy. Valid values are integers between 0 and 256, inclusive
child_healthchecks List[str]: For a specified parent health check, a list of HealthCheckId values for the associated child health checks.
cloudwatch_alarm_name str: The name of the CloudWatch alarm.
cloudwatch_alarm_region str: The CloudWatchRegion that the CloudWatch alarm was created in.
enable_sni bool: A boolean value that indicates whether Route53 should send the fqdn to the endpoint when performing the health check. This defaults to AWS’ defaults: when the type is “HTTPS” enable_sni defaults to true, when type is anything else enable_sni defaults to false.
failure_threshold float: The number of consecutive health checks that an endpoint must pass or fail.
fqdn str: The fully qualified domain name of the endpoint to be checked.
insufficient_data_health_status str: The status of the health check when CloudWatch has insufficient data about the state of associated alarm. Valid values are Healthy , Unhealthy and LastKnownStatus.
invert_healthcheck bool: A boolean value that indicates whether the status of health check should be inverted. For example, if a health check is healthy but Inverted is True , then Route 53 considers the health check to be unhealthy.
ip_address str: The IP address of the endpoint to be checked.
measure_latency bool: A Boolean value that indicates whether you want Route 53 to measure the latency between health checkers in multiple AWS regions and your endpoint and to display CloudWatch latency graphs in the Route 53 console.
port float: The port of the endpoint to be checked.
reference_name str: This is a reference name used in Caller Reference (helpful for identifying single health_check set amongst others)
regions List[str]: A list of AWS regions that you want Amazon Route 53 health checkers to check the specified endpoint from.
request_interval float: The number of seconds between the time that Amazon Route 53 gets a response from your endpoint and the time that it sends the next health-check request.
resource_path str: The path that you want Amazon Route 53 to request when performing health checks.
search_string str: String searched in the first 5120 bytes of the response body for check to be considered healthy. Only valid with HTTP_STR_MATCH and HTTPS_STR_MATCH.
tags Dict[str, str]: A map of tags to assign to the health check.
type str: The protocol to use when performing health checks. Valid values are HTTP, HTTPS, HTTP_STR_MATCH, HTTPS_STR_MATCH, TCP, CALCULATED and CLOUDWATCH_METRIC.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud